diff --git a/docs/realtime/best-practices.md b/docs/realtime/best-practices.md index 6bf205cc2..82c619d21 100644 --- a/docs/realtime/best-practices.md +++ b/docs/realtime/best-practices.md @@ -1,7 +1,3 @@ - - - - # GTFS Realtime Best Practices ## Introduction @@ -158,3 +154,5 @@ GTFS applications and practices evolve, and so this document may need to be amen Please link here in order to provide feed producers with guidance for correct formation of GTFS Realtime data. Each individual recommendation has an anchor link. Click the recommendation to get the URL for the in-page anchor link. If a GTFS Realtime-consuming application makes requirements or recommendations for GTFS Realtime data practices that are not described here, it is recommended to publish a document with those requirements or recommendations to supplement these common best practices. + + diff --git a/docs/realtime/feed-entities/index.md b/docs/realtime/feed-entities/index.md index 79ac0b3eb..a137e24ab 100644 --- a/docs/realtime/feed-entities/index.md +++ b/docs/realtime/feed-entities/index.md @@ -1,7 +1,3 @@ - - - - # Feed Entities GTFS Realtime supports three distinct types of realtime data, that can be diff --git a/docs/realtime/feed-entities/service-alerts.md b/docs/realtime/feed-entities/service-alerts.md index 121871bc7..0aa6b6742 100644 --- a/docs/realtime/feed-entities/service-alerts.md +++ b/docs/realtime/feed-entities/service-alerts.md @@ -1,7 +1,3 @@ - - - - # Service Alerts Service alerts allow you to provide updates whenever there is disruption on the network. Delays and cancellations of individual trips should usually be communicated using [Trip updates](trip-updates.md). diff --git a/docs/realtime/feed-entities/trip-updates.md b/docs/realtime/feed-entities/trip-updates.md index a22e8cc84..f527b9c9e 100644 --- a/docs/realtime/feed-entities/trip-updates.md +++ b/docs/realtime/feed-entities/trip-updates.md @@ -1,7 +1,3 @@ - - - - # Trip Updates Trip updates represent fluctuations in the timetable. We would expect to receive trip updates for all trips you have scheduled that are realtime-capable. These updates would give a predicted arrival or departure time for stops along the route. Trip updates can also provide for more complex scenarios where trips are canceled or added to the schedule, or even re-routed. diff --git a/docs/realtime/feed-entities/vehicle-positions.md b/docs/realtime/feed-entities/vehicle-positions.md index 9994e7f05..b9fcff728 100644 --- a/docs/realtime/feed-entities/vehicle-positions.md +++ b/docs/realtime/feed-entities/vehicle-positions.md @@ -1,7 +1,3 @@ - - - - # Vehicle Positions Vehicle position is used to provide automatically generated information on the location of a vehicle, such as from a GPS device on board. A single vehicle position should be provided for every vehicle that is capable of providing it. diff --git a/docs/realtime/feed-examples/service-alerts.md b/docs/realtime/feed-examples/service-alerts.md index 2976a0d68..efc85fe5f 100644 --- a/docs/realtime/feed-examples/service-alerts.md +++ b/docs/realtime/feed-examples/service-alerts.md @@ -1,7 +1,3 @@ - - - - # Service alert The following example is an ASCII representation of an Alert feed. @@ -86,3 +82,5 @@ entity { } } ``` + + diff --git a/docs/realtime/feed-examples/trip-updates.md b/docs/realtime/feed-examples/trip-updates.md index ba0647ea2..ec6c3e20f 100644 --- a/docs/realtime/feed-examples/trip-updates.md +++ b/docs/realtime/feed-examples/trip-updates.md @@ -1,7 +1,3 @@ - - - - # Trip Update The following example is an ASCII representation of an full-dataset Trip Update feed. @@ -86,3 +82,5 @@ entity { } } ``` + + diff --git a/docs/realtime/index.md b/docs/realtime/index.md index 4dfb2ca5b..f7d3041b3 100644 --- a/docs/realtime/index.md +++ b/docs/realtime/index.md @@ -1,7 +1,3 @@ - - - - # GTFS Realtime Overview
diff --git a/docs/realtime/language-bindings/dotnet.md b/docs/realtime/language-bindings/dotnet.md index 893f9cf2d..6c0f87b4b 100644 --- a/docs/realtime/language-bindings/dotnet.md +++ b/docs/realtime/language-bindings/dotnet.md @@ -1,7 +1,3 @@ - - - - # .NET GTFS-realtime Language Bindings [![NuGet version](https://badge.fury.io/nu/GtfsRealtimeBindings.svg)](http://badge.fury.io/nu/GtfsRealtimeBindings) diff --git a/docs/realtime/language-bindings/golang.md b/docs/realtime/language-bindings/golang.md index 823276c51..5d2ba62b3 100644 --- a/docs/realtime/language-bindings/golang.md +++ b/docs/realtime/language-bindings/golang.md @@ -1,7 +1,3 @@ - - - - # Golang GTFS-realtime Language Bindings Provides Golang structs generated from the diff --git a/docs/realtime/language-bindings/index.md b/docs/realtime/language-bindings/index.md index ef6027b94..abff4c1e5 100644 --- a/docs/realtime/language-bindings/index.md +++ b/docs/realtime/language-bindings/index.md @@ -1,7 +1,3 @@ - - - - # gtfs-realtime-bindings [![Join the MobilityData chat](https://img.shields.io/badge/chat-on%20slack-red)](https://share.mobilitydata.org/slack) Language bindings generated from the diff --git a/docs/realtime/language-bindings/java.md b/docs/realtime/language-bindings/java.md index be5a7a198..6c7142dd9 100644 --- a/docs/realtime/language-bindings/java.md +++ b/docs/realtime/language-bindings/java.md @@ -1,7 +1,3 @@ - - - - # Java GTFS-realtime Language Bindings ![Maven Central Version](https://img.shields.io/maven-central/v/org.mobilitydata/gtfs-realtime-bindings.svg) diff --git a/docs/realtime/language-bindings/nodejs.md b/docs/realtime/language-bindings/nodejs.md index c1b7c69a9..cca515a95 100644 --- a/docs/realtime/language-bindings/nodejs.md +++ b/docs/realtime/language-bindings/nodejs.md @@ -1,7 +1,3 @@ - - - - # JavaScript GTFS-realtime Language Bindings [![npm version](https://badge.fury.io/js/gtfs-realtime-bindings.svg)](http://badge.fury.io/js/gtfs-realtime-bindings) diff --git a/docs/realtime/language-bindings/python.md b/docs/realtime/language-bindings/python.md index 1494c4b74..a67e4f841 100644 --- a/docs/realtime/language-bindings/python.md +++ b/docs/realtime/language-bindings/python.md @@ -1,7 +1,3 @@ - - - - # Python GTFS-realtime Language Bindings [![PyPI version](https://badge.fury.io/py/gtfs-realtime-bindings.svg)](http://badge.fury.io/py/gtfs-realtime-bindings) diff --git a/docs/realtime/proto.md b/docs/realtime/proto.md index 1c6d705d9..eb1c1a141 100644 --- a/docs/realtime/proto.md +++ b/docs/realtime/proto.md @@ -1,7 +1,3 @@ - - - - # GTFS Realtime Protobuf Download the [gtfs-realtime.proto](gtfs-realtime.proto) file and use it to compile your GTFS-realtime feed. The contents of the file are shown inline below. For more information about using protobufs, see the [Protocol Buffers Developer Guide](https://developers.google.com/protocol-buffers/docs/overview). @@ -1042,3 +1038,4 @@ message Shape { extensions 9000 to 9999; } ``` + diff --git a/docs/realtime/reference.md b/docs/realtime/reference.md index 0c21180e3..b18b6dfcb 100644 --- a/docs/realtime/reference.md +++ b/docs/realtime/reference.md @@ -1,7 +1,3 @@ - - - - # GTFS Realtime Reference A GTFS Realtime feed lets transit agencies provide consumers with realtime information about disruptions to their service (stations closed, lines not operating, important delays, etc.) location of their vehicles, and expected arrival times. diff --git a/docs/resources/agency-tools.md b/docs/resources/agency-tools.md index fdd1242e4..cc7436df1 100644 --- a/docs/resources/agency-tools.md +++ b/docs/resources/agency-tools.md @@ -1,7 +1,4 @@ - - - - # Agency Tools +# Agency Tools Tools for transit agencies. See also [GTFS Data Collection and Maintenance Tools](#gtfs-data-collection-and-maintenance-tools) for tools specific to GTFS. @@ -14,3 +11,4 @@ Tools for transit agencies. See also [GTFS Data Collection and Maintenance Tool - [TNExT](https://github.com/ODOT-PTS/TNExT) - Transit Network Explorer Tool (TNExT) is a web-based software tool developed for the visualization, analysis, and reporting of regional and statewide transit networks in the state of Oregon. - Route Trends ([webapp](https://metrotransitmn.shinyapps.io/route-trends/), [GitHub](https://github.com/metrotransit/route-trends)) - An R Shiny app to ingest ridership time series, and return seasonal, trend, and residual components according to [STL methodology](https://otexts.com/fpp2/stl.html) and forecasts including uncertainty based on those components. Sponsored by [Metro Transit](https://www.metrotransit.org/) (Minneapolis-St. Paul). - [TBEST](https://tbest.org/) - TBEST (Transit Boardings Estimation and Simulation Tool) is an effort to develop a multi-faceted GIS-based modeling, planning and analysis tool which integrates socio-economic, land use, and transit network data into a platform for scenario-based transit ridership estimation and analysis. Funded by the Florida Department of Transportation. Free to use but not open-source. + diff --git a/docs/resources/apps.md b/docs/resources/apps.md index 8f4a23ec5..73046b4c1 100644 --- a/docs/resources/apps.md +++ b/docs/resources/apps.md @@ -1,7 +1,4 @@ - - - - # Apps +# Apps Apps people use when taking transit. @@ -55,3 +52,4 @@ Apps people use when taking transit. - [TransLoc Rider](http://translocrider.com/) - Real-time transit maps for over 100 transit systems. - [Transit Display](http://transitdisplay.com/) - Multimodal and real-time transit display software. - [Ualabee](https://ualabee.com/company/) - Community driven trip planner with focus on user interaction, users can report anomalies, upload pictures, edit transit data and chat with other passengers. + diff --git a/docs/resources/community.md b/docs/resources/community.md index 2e9701c25..5ee140b6c 100644 --- a/docs/resources/community.md +++ b/docs/resources/community.md @@ -1,7 +1,4 @@ - - - - # Community +# Community Places to ask questions and find other community resources. @@ -18,3 +15,4 @@ Places to ask questions and find other community resources. - [OneBusAway API mailing list](http://groups.google.com/group/onebusaway-api) - [OneBusAway Slack chat](https://onebusaway.herokuapp.com/) - [Transit Techies NYC](https://transittechies.nyc/) - NYC-based meetup for those interested in this repo. [Speaker list](https://transittechies.nyc/past) includes many contributors to this repo. + diff --git a/docs/resources/data.md b/docs/resources/data.md index f101ae35f..7441d1f45 100644 --- a/docs/resources/data.md +++ b/docs/resources/data.md @@ -1,7 +1,4 @@ - - - - # Data +# Data Places to access collections of GTFS and other transit and multimodal data @@ -44,3 +41,4 @@ Places to access collections of GTFS and other transit and multimodal data - [GTFS Realtime - JSON test cases that are turned into PB contents](https://github.com/interline-io/transitland-server/tree/main/test/data/rt) - [gtfs-realtime-validator unit tests](https://github.com/MobilityData/gtfs-realtime-validator/tree/master/gtfs-realtime-validator-lib/src/test/) - Some [GTFS datasets (zip files)](https://github.com/MobilityData/gtfs-realtime-validator/tree/master/gtfs-realtime-validator-lib/src/test/resources) are included and a large number of GTFS RT messages are defined [programmatically in Java](https://github.com/MobilityData/gtfs-realtime-validator/tree/master/gtfs-realtime-validator-lib/src/test/java/edu/usf/cutr/gtfsrtvalidator/lib/test/rules) via the gtfs-realtime-bindings library. - [OpenTripPlanner unit tests](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/src/test) - Some [GTFS datasets](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/src/test/resources/gtfs) are defined for the unit tests ([GtfsTest](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/test/java/org/opentripplanner/GtfsTest.java) and [mmri folder](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/src/test/java/org/opentripplanner/mmri)). + diff --git a/docs/resources/getting-started.md b/docs/resources/getting-started.md index e5cb56b4c..553a73a11 100644 --- a/docs/resources/getting-started.md +++ b/docs/resources/getting-started.md @@ -1,7 +1,4 @@ - - - - # Getting started +# Getting started If this is your first time dealing with transit data, you might find these links useful: @@ -10,3 +7,5 @@ If this is your first time dealing with transit data, you might find these links - [World Bank - "Intro. to GTFS" online course](https://olc.worldbank.org/content/introduction-general-transit-feed-specification-gtfs-and-informal-transit-system-mapping) - A free, online, self-paced course for learning about GTFS and GTFS-realtime. - [Open Transit Data Toolkit](http://transitdatatoolkit.com/) - A series of lessons to help people utilize open transit data. - [MBTA GTFS Onboarding](https://mybinder.org/v2/gh/mbta/gtfs_onboarding/main?urlpath=lab/tree/GTFS_Onboarding.ipynb) - An interactive tutorial created by MBTA for GTFS static. A [stand-alone Docker image](https://github.com/mbta/gtfs_onboarding) is available on GitHub as well as a [hosted/no-install version](https://mybinder.org/v2/gh/mbta/gtfs_onboarding/main?urlpath=lab/tree/GTFS_Onboarding.ipynb) of the Jupyter notebook. + + diff --git a/docs/resources/gtfs-realtime.md b/docs/resources/gtfs-realtime.md index cc46b078b..c4cfe4a79 100644 --- a/docs/resources/gtfs-realtime.md +++ b/docs/resources/gtfs-realtime.md @@ -1,7 +1,4 @@ - - - - # GTFS Realtime +# GTFS Realtime - [GTFS-realtime documentation](https://github.com/google/transit/tree/master/gtfs-realtime). Also available in [Español](https://github.com/google/transit/tree/master/gtfs-realtime/spec/es). - [GTFS-realtime Autodoc](https://laidig.github.io/gtfs-rt-autodoc/index.html) - Automatically generated documentation for GTFS-realtime, generated from the official [GTFS-realtime protocol buffer specification](https://github.com/google/transit/blob/master/gtfs-realtime/proto/gtfs-realtime.proto) and including some extensions. @@ -65,3 +62,4 @@ Massachusetts Bay Transportation Authority (MBTA)](https://github.com/mbta). - [transit-feed-quality-calculator](https://github.com/CUTR-at-USF/transit-feed-quality-calculator) - A Java project that uses the [gtfs-realtime-validator](https://github.com/CUTR-at-USF/gtfs-realtime-validator) to assess the quality of a large number of transit feeds, fetching the feed URLs from a global directory ([TransitFeeds.com/OpenMobilityData.org](https://openmobilitydata.org/)). - [Transit Network Model](https://github.com/tmelliott/TransitNetworkModel) - A tool to generate predictions using GTFS-realtime VehiclePositions, a particle filter, and a Kalman Filter. - [GTFS Realtime Display](https://git.wtf-eg.de/dancesWithCycles/gtfs-rt-display) - Analyse, monitor and maintain GTFS Realtime data. [Example instances](https://www.swingbe.de/activity/gtfs-rt-display/) + diff --git a/docs/resources/gtfs.md b/docs/resources/gtfs.md index 5facb7be3..07873df2d 100644 --- a/docs/resources/gtfs.md +++ b/docs/resources/gtfs.md @@ -1,7 +1,4 @@ - - - - # GTFS +# GTFS - [GTFS Spec](https://gtfs.org/schedule/reference/) - Specification for the General Transit Data Feed, or GTFS. Available in several languages. - [GTFS Best Practices](http://gtfs.org/best-practices/) - Best practices for producers of a GTFS feed. @@ -145,3 +142,5 @@ Converters from various static schedule formats to and from GTFS. - [Reflect GTFS Validator (hosted by Foursquare ITP)](https://reflect.foursquareitp.com) - Transit schedule and GTFS validation platform by [Foursquare ITP](https://www.foursquareitp.com) that includes a free, web-based GTFS validator based on [gtfs-lib](https://github.com/conveyal/gtfs-lib/). - [Transit App's gtfs-fares-v2-validator](https://github.com/TransitApp/gtfs-fares-v2-validator) - A Python tool that validators GTFS-Fares-v2 data based on the [draft specification](https://docs.google.com/document/d/19j-f-wZ5C_kYXmkLBye1g42U-kvfSVgYLkkG5oyBauY/edit#). - [Transport Validator](https://github.com/etalab/transport-validator/) - An open-source validator implemented in [Rust](https://www.rust-lang.org/). Used by the [French National Access Point](https://transport.data.gouv.fr/validation/). + + diff --git a/docs/resources/hardware.md b/docs/resources/hardware.md index fb4a6573c..f9edffcf5 100644 --- a/docs/resources/hardware.md +++ b/docs/resources/hardware.md @@ -1,8 +1,6 @@ - - - - # Hardware +# Hardware Experimental and production transit hardware. - [Bus Tracking GPS](https://github.com/herrdragon/busTrackingGps) - Code for Miami prototype of a cheap open-source solution to track transit buses. + diff --git a/docs/resources/multimodal.md b/docs/resources/multimodal.md index b38f1e182..dd58a82cd 100644 --- a/docs/resources/multimodal.md +++ b/docs/resources/multimodal.md @@ -1,7 +1,4 @@ - - - - # Other multimodal data formats +# Other multimodal data formats - [Alliance for Parking Data Standards (APDS)](https://www.allianceforparkingdatastandards.org/) - Formed by the [International Parking Institute (IPI)](https://www.parking.org/), the [British Parking Association (BPA)](http://www.britishparking.co.uk/), and the [European Parking Association (EPA)](http://www.europeanparking.eu/), APDS is a not-for-profit organization with the mission to develop, promote, manage, and maintain a uniform global standard that will allow organizations to share parking data across platforms worldwide. APDS Version 1.0 documents are [here](https://www.allianceforparkingdatastandards.org/resources). - [CurbLR](https://github.com/curblr/curblr-spec) - A specification for curb regulations. @@ -30,3 +27,4 @@ - [TIDES project](https://github.com/TIDES-transit/TIDES) - Transit ITS Data Exchange Specification (TIDES) is a proposed effort to create standard data structures, APIs, and data management tools for historical transit ITS data including AVL, APC and AFC Data. - [Cal-ITP Operational Data Standard (ODS)](https://docs.calitp.org/operational-data-standard/) - Intended to address the lack of a standard format for representing transit schedules used by drivers, dispatchers, and planners to carry out transit operations. - [Transport Operator Mobility-as-a-service Provider (TOMP)-API](https://github.com/TOMP-WG/TOMP-API) - Working group in the Netherlands with a goal to develop an API for use by Transport Operators and Mobility-as-a-service Providers for operator discovery, trip planning, end user interaction, booking, and payment. + diff --git a/docs/resources/other.md b/docs/resources/other.md index e9d1cd29b..162254116 100644 --- a/docs/resources/other.md +++ b/docs/resources/other.md @@ -1,7 +1,4 @@ - - - - # Other Resources +# Other Resources On-line courses, blog posts, and reports related to open transit data. @@ -45,3 +42,4 @@ On-line courses, blog posts, and reports related to open transit data. ## Community-maintained lists - [Vendors Providing GTFS Creation/Maintenance services](https://docs.google.com/spreadsheets/u/1/d/1Gc9mu4BIYC8ORpv2IbbVnT3q8VQ3xkeY7Hz068vT_GQ/pubhtml) - Add new vendors [here](http://goo.gl/forms/YDbPSPmufS). - [Entities Providing Transportation Software Development Consulting Services](https://docs.google.com/spreadsheets/u/1/d/1n44CNMCK1vt1nyrsdYz-KD_hYxUMNIm6Me69M6ROBIg/pubhtml) - Add new entities [here](http://goo.gl/forms/cc6kcVERuP). + diff --git a/docs/resources/sdk.md b/docs/resources/sdk.md index 287d6aad1..1b663ebbc 100644 --- a/docs/resources/sdk.md +++ b/docs/resources/sdk.md @@ -1,5 +1,3 @@ - - - - # SDKs +# SDKs - [Citymapper SDK](https://citymapper.com/powers) - Allows you to add journey planning and turn-by-turn navigation for walking, cycling, scooting and transit into native iOS and Android apps. + diff --git a/docs/resources/siri.md b/docs/resources/siri.md index aa08f6b60..0c90826f5 100644 --- a/docs/resources/siri.md +++ b/docs/resources/siri.md @@ -1,7 +1,4 @@ - - - - # SIRI +# SIRI - [SIRI API](https://github.com/OneBusAway/onebusaway/wiki/SIRI-Resources) - Java classes generated from the v1.0 and v1.3 [SIRI](https://www.siri.org.uk/) schemas. - [SIRI 2.0 API](https://github.com/laidig/siri-20-java) - Java classes generated from the v2.0 [SIRI](https://www.siri.org.uk/) schemas. @@ -12,3 +9,4 @@ - [SIRI 1.3 POJOs (Android-compatible)](https://github.com/CUTR-at-USF/onebusaway-siri-api-v13-pojos/wiki) - Android-compatible Plain Old Java Objects (POJOSs) used for data binding (deserliazing XML/JSON) responses for SIRI v1.3 APIs. Used by the [SIRI REST Client](https://github.com/CUTR-at-USF/SiriRestClient/wiki). - [pysiri2validator](https://github.com/laidig/pysiri2validator) - Simple validator for SIRI 2.0 written in Python 3. - [Edwig](https://github.com/af83/edwig) - A golang server for real-time public transport data exchange, using the SIRI protocol. + diff --git a/docs/resources/software-for-creating-apis.md b/docs/resources/software-for-creating-apis.md index 0c1381991..39168a34a 100644 --- a/docs/resources/software-for-creating-apis.md +++ b/docs/resources/software-for-creating-apis.md @@ -1,7 +1,4 @@ - - - - # Software for Creating APIs +# Software for Creating APIs Software that you can set up to provide an API to transit and multimodal data. @@ -16,3 +13,4 @@ Software that you can set up to provide an API to transit and multimodal data. - [pyBikes](https://github.com/eskerda/pybikes) - Software powering [CityBikes](http://api.citybik.es) for worldwide bikeshare system info - [TransitClock](http://thetransitclock.org) - Java application that can consume raw vehicle positions and generate prediction times in formats such as GTFS-realtime. Formerly known as "Transitime". - [TransiCast](http://www.transicast.com/) - Provides public transportation data for North America in a single, integrated call and response format. The data is provided in stream-parsable XML and JSON formats. Open-source on [Google Code](https://code.google.com/archive/p/rasa/). Hosted version at www.transitcast.com [requires payment](http://www.transicast.com/coststructure.html). + diff --git a/docs/resources/visualizations.md b/docs/resources/visualizations.md index 7c8a8e6f1..61d9941f5 100644 --- a/docs/resources/visualizations.md +++ b/docs/resources/visualizations.md @@ -1,7 +1,4 @@ - - - - # Visualizations +# Visualizations - [All Transit](https://all-transit.com) - Interactive GTFS route and schedule animation (for U.S. cities) using Mapbox GL JS, Deck.gl and Transitland. Github repository [here](https://github.com/kylebarron/all-transit). - [fastest-bus-analysis-in-the-west](https://github.com/vta/fastest-bus-analysis-in-the-west) - A python Pandas script that combines Ridership/APC, Swiftly speed and dwell data, bus stop inventory, GTFS, and geospatial shapes to create a stop by stop, route by route, time grouping filterable dataset for cross-analyses. The dataset is then visualized in [Tableau](https://public.tableau.com/profile/vivek7797#!/vizhome/stopsandspeedanalyses/Story1) to help VTA Planners find places to make bus and rail network faster and more reliable through speedups methods like stop consolidation and dedicated lanes. @@ -19,3 +16,4 @@ - [TRAVIC Transit Visualization Client](http://tracker.geops.ch/) - Visualizes vehicles moving based on static GTFS data (and sometimes realtime data). Supports over 260 cities. Github account for geOps organization is [here](https://github.com/geops). - [Traze](https://traze.app/) by [Veridict](https://www.veridict.com) - Visualization of public transport vehicles from all over the world. Collaborate with other users to get real-time updates even when it is not available from the agency. Based on a number of sources, including GTFS and GTFS-RT. (Previously known as [Livemap24](https://www.livemap24.com)). - [Visualizing MBTA Data](http://mbtaviz.github.io/) - Interactive graphs that show how people use Boston's subway system. + diff --git a/docs/schedule/best-practices.md b/docs/schedule/best-practices.md index a2b9001ca..f4e2b1a61 100644 --- a/docs/schedule/best-practices.md +++ b/docs/schedule/best-practices.md @@ -1,7 +1,3 @@ - - - - # GTFS Schedule Best Practices These are recommended practices for describing public transportation services in the [General Transit Feed Specification (GTFS)](../reference). These practices have been synthesized from the experience of the [GTFS Best Practices working group](#gtfs-best-practices-working-group) members and [application-specific GTFS practice recommendations](http://www.transitwiki.org/TransitWiki/index.php/Best_practices_for_creating_GTFS). diff --git a/docs/schedule/example-feed.md b/docs/schedule/example-feed.md index f3467c17e..bec61640a 100644 --- a/docs/schedule/example-feed.md +++ b/docs/schedule/example-feed.md @@ -1,7 +1,3 @@ - - - - # Example GTFS Feed This example GTFS feed shows comma-delimited data samples for each file in a transit feed. The sample data files shown here aren't all related to each other. You can also [download a complete GTFS feed](https://github.com/google/transit/blob/master/gtfs/spec/en/examples/sample-feed-1.zip?raw=true) in final form to work with as well, or browse the individual files of that same feed online [here](https://github.com/google/transit/tree/master/gtfs/spec/en/examples/sample-feed-1). @@ -201,4 +197,4 @@ attribution_id,is_producer,is_operator,organization_name,agency_id attribution001,1,0,Transit Feed Solutions USA,agency001 attribution002,0,1,Transit Bus Operations USA ,agency001 [...] -``` +``` \ No newline at end of file diff --git a/docs/schedule/reference.md b/docs/schedule/reference.md index 98062a9b0..1fc71694c 100644 --- a/docs/schedule/reference.md +++ b/docs/schedule/reference.md @@ -1,10 +1,6 @@ - - - - # GTFS Schedule Reference -**Revised Dec 8, 2022. See [Revision History](../revision-history) for more details.** +**Revised Nov 16, 2023. See [Revision History](../revision-history) for more details.** This document defines the format and structure of the files that comprise a GTFS dataset. @@ -149,6 +145,20 @@ The following example demonstrates how a field value would appear in a comma-del * Each line must end with a CRLF or LF linebreak character. * Files should be encoded in UTF-8 to support all Unicode characters. Files that include the Unicode byte-order mark (BOM) character are acceptable. See [http://unicode.org/faq/utf_bom.html#BOM](http://unicode.org/faq/utf_bom.html#BOM) for more information on the BOM character and UTF-8. * All dataset files must be zipped together. The files must reside at the root level directly, not in a subfolder. +* All customer-facing text strings (including stop names, route names, and headsigns) should use Mixed Case (not ALL CAPS), following local conventions for capitalization of place names on displays capable of displaying lower case characters (e.g. “Brighton Churchill Square”, “Villiers-sur-Marne”, “Market Street”). +* The use of abbreviations should be avoided throughout the feed for names and other text (e.g. St. for Street) unless a location is called by its abbreviated name (e.g. “JFK Airport”). Abbreviations may be problematic for accessibility by screen reader software and voice user interfaces. Consuming software can be engineered to reliably convert full words to abbreviations for display, but converting from abbreviations to full words is prone to more risk of error. + +## Dataset Publishing & General Practices + +* Datasets should be published at a public, permanent URL, including the zip file name. (e.g., www.agency.org/gtfs/gtfs.zip). Ideally, the URL should be directly downloadable without requiring login to access the file, to facilitate download by consuming software applications. While it is recommended (and the most common practice) to make a GTFS dataset openly downloadable, if a data provider does need to control access to GTFS for licensing or other reasons, it is recommended to control access to the GTFS dataset using API keys, which will facilitate automatic downloads. +* GTFS data should be published in iterations so that a single file at a stable location always contains the latest official description of service for a transit agency (or agencies). +* Datasets should maintain persistent identifiers (id fields) for `stop_id`, `route_id`, and `agency_id` across data iterations whenever possible. +* One GTFS dataset should contain current and upcoming service (sometimes called a “merged” dataset). There are multiple [merge tools](https://gtfs.org/resources/gtfs/#gtfs-merge-tools) available that can be used to create a merged dataset from two different GTFS feeds. + * At any time, the published GTFS dataset should be valid for at least the next 7 days, and ideally for as long as the operator is confident that the schedule will continue to be operated. + * If possible, the GTFS dataset should cover at least the next 30 days of service. + * Old services (expired calendars) should be removed from the feed. + * If a service modification will go into effect in 7 days or fewer, this service change should be expressed through a GTFS-realtime feed (service advisories or trip updates) rather than static GTFS dataset. + * The web-server hosting GTFS data should be configured to correctly report the file modification date (see [HTTP/1.1 - Request for Comments 2616, under Section 14.29](https://tools.ietf.org/html/rfc2616#section-14.29)https://tools.ietf.org/html/rfc2616#section-14.29). ## Field Definitions