From 9c4faa1bc1f6279d6a070659112743c37a9abe0b Mon Sep 17 00:00:00 2001 From: farah-machlab-ibigroup Date: Wed, 9 Jan 2019 16:10:03 -0500 Subject: [PATCH 1/6] Update .proto and documentation for new tts_ivr field --- gtfs-realtime/proto/gtfs-realtime.proto | 3 +++ gtfs-realtime/spec/en/reference.md | 1 + gtfs-realtime/spec/en/service-alerts.md | 1 + 3 files changed, 5 insertions(+) diff --git a/gtfs-realtime/proto/gtfs-realtime.proto b/gtfs-realtime/proto/gtfs-realtime.proto index 76057b9d..bfdab8d3 100644 --- a/gtfs-realtime/proto/gtfs-realtime.proto +++ b/gtfs-realtime/proto/gtfs-realtime.proto @@ -427,6 +427,9 @@ message Alert { // Full description for the alert as plain-text. The information in the // description should add to the information of the header. optional TranslatedString description_text = 11; + + // Text containing a message to be used by an IVR system's text-to-speech generator. + optional TranslatedString tts_ivr = 12; // The extensions namespace allows 3rd-party developers to extend the // GTFS Realtime Specification in order to add and evaluate new features diff --git a/gtfs-realtime/spec/en/reference.md b/gtfs-realtime/spec/en/reference.md index a4a91880..5f73cff7 100644 --- a/gtfs-realtime/spec/en/reference.md +++ b/gtfs-realtime/spec/en/reference.md @@ -265,6 +265,7 @@ An alert, indicating some sort of incident in the public transit network. | **url** | [TranslatedString](#message-translatedstring) | Optional | One | The URL which provides additional information about the alert. | | **header_text** | [TranslatedString](#message-translatedstring) | Required | One | Header for the alert. This plain-text string will be highlighted, for example in boldface. | | **description_text** | [TranslatedString](#message-translatedstring) | Required | One | Description for the alert. This plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user). The information in the description should add to the information of the header. | +| **tts_ivr** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing a message to be used by an IVR system's text-to-speech generator. | ## _enum_ Cause diff --git a/gtfs-realtime/spec/en/service-alerts.md b/gtfs-realtime/spec/en/service-alerts.md index bc6f58d2..6a257ee5 100644 --- a/gtfs-realtime/spec/en/service-alerts.md +++ b/gtfs-realtime/spec/en/service-alerts.md @@ -5,6 +5,7 @@ You have the option to provide the following: * URL - link to your site explaining more about the alert * Header text - a summary of the alert * Description - a full description of the alert, which will always be shown alongside the header (so should not repeat this information). +* IVR text-to-speech text - the text containing a message to be used by an IVR system's text-to-speech generator. ### Time Range From a164609b7bc5aac4944268efeb3331cc25427419 Mon Sep 17 00:00:00 2001 From: farah-machlab-ibigroup Date: Thu, 10 Jan 2019 16:56:50 -0500 Subject: [PATCH 2/6] Remove changes from service-alerts.md --- gtfs-realtime/spec/en/service-alerts.md | 1 - 1 file changed, 1 deletion(-) diff --git a/gtfs-realtime/spec/en/service-alerts.md b/gtfs-realtime/spec/en/service-alerts.md index 6a257ee5..bc6f58d2 100644 --- a/gtfs-realtime/spec/en/service-alerts.md +++ b/gtfs-realtime/spec/en/service-alerts.md @@ -5,7 +5,6 @@ You have the option to provide the following: * URL - link to your site explaining more about the alert * Header text - a summary of the alert * Description - a full description of the alert, which will always be shown alongside the header (so should not repeat this information). -* IVR text-to-speech text - the text containing a message to be used by an IVR system's text-to-speech generator. ### Time Range From 01a8783effac0ae236e7cdf2aa0226bf0af7a2df Mon Sep 17 00:00:00 2001 From: ibi-group-team Date: Mon, 21 Jan 2019 11:22:57 -0500 Subject: [PATCH 3/6] Update proposal to tts_header_text and tts_description_text --- gtfs-realtime/proto/gtfs-realtime.proto | 7 +++++-- gtfs-realtime/spec/en/reference.md | 3 ++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/gtfs-realtime/proto/gtfs-realtime.proto b/gtfs-realtime/proto/gtfs-realtime.proto index bfdab8d3..11fc1db0 100644 --- a/gtfs-realtime/proto/gtfs-realtime.proto +++ b/gtfs-realtime/proto/gtfs-realtime.proto @@ -428,8 +428,11 @@ message Alert { // description should add to the information of the header. optional TranslatedString description_text = 11; - // Text containing a message to be used by an IVR system's text-to-speech generator. - optional TranslatedString tts_ivr = 12; + // Text for alert header to be used in text-to-speech implementations. + optional TranslatedString tts_header_text = 12; + + //Text for full description for the alert to be used in text-to-speech implementations. + optional TranslatedString tts_description_text = 13; // The extensions namespace allows 3rd-party developers to extend the // GTFS Realtime Specification in order to add and evaluate new features diff --git a/gtfs-realtime/spec/en/reference.md b/gtfs-realtime/spec/en/reference.md index 5f73cff7..bafbbd4a 100644 --- a/gtfs-realtime/spec/en/reference.md +++ b/gtfs-realtime/spec/en/reference.md @@ -265,7 +265,8 @@ An alert, indicating some sort of incident in the public transit network. | **url** | [TranslatedString](#message-translatedstring) | Optional | One | The URL which provides additional information about the alert. | | **header_text** | [TranslatedString](#message-translatedstring) | Required | One | Header for the alert. This plain-text string will be highlighted, for example in boldface. | | **description_text** | [TranslatedString](#message-translatedstring) | Required | One | Description for the alert. This plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user). The information in the description should add to the information of the header. | -| **tts_ivr** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing a message to be used by an IVR system's text-to-speech generator. | +| **tts_header_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing the alert's header to be used for text-to-speech implementations. | +| **tts_description_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing a description for the alert to be used for text-to-speech implementations. | ## _enum_ Cause From f3bba4607292f358bdd7582b0028511ab51080f0 Mon Sep 17 00:00:00 2001 From: ibi-group-team Date: Mon, 21 Jan 2019 12:55:15 -0500 Subject: [PATCH 4/6] Add reference to header_text and description_text --- gtfs-realtime/proto/gtfs-realtime.proto | 4 ++-- gtfs-realtime/spec/en/reference.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/gtfs-realtime/proto/gtfs-realtime.proto b/gtfs-realtime/proto/gtfs-realtime.proto index 11fc1db0..30b42546 100644 --- a/gtfs-realtime/proto/gtfs-realtime.proto +++ b/gtfs-realtime/proto/gtfs-realtime.proto @@ -428,10 +428,10 @@ message Alert { // description should add to the information of the header. optional TranslatedString description_text = 11; - // Text for alert header to be used in text-to-speech implementations. + // Text for alert header to be used in text-to-speech implementations. This field is the text-to-speech version of header_text. optional TranslatedString tts_header_text = 12; - //Text for full description for the alert to be used in text-to-speech implementations. + //Text for full description for the alert to be used in text-to-speech implementations. This field is the text-to-speech version of description_text. optional TranslatedString tts_description_text = 13; // The extensions namespace allows 3rd-party developers to extend the diff --git a/gtfs-realtime/spec/en/reference.md b/gtfs-realtime/spec/en/reference.md index bafbbd4a..1bb59214 100644 --- a/gtfs-realtime/spec/en/reference.md +++ b/gtfs-realtime/spec/en/reference.md @@ -265,8 +265,8 @@ An alert, indicating some sort of incident in the public transit network. | **url** | [TranslatedString](#message-translatedstring) | Optional | One | The URL which provides additional information about the alert. | | **header_text** | [TranslatedString](#message-translatedstring) | Required | One | Header for the alert. This plain-text string will be highlighted, for example in boldface. | | **description_text** | [TranslatedString](#message-translatedstring) | Required | One | Description for the alert. This plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user). The information in the description should add to the information of the header. | -| **tts_header_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing the alert's header to be used for text-to-speech implementations. | -| **tts_description_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing a description for the alert to be used for text-to-speech implementations. | +| **tts_header_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing the alert's header to be used for text-to-speech implementations. This field is the text-to-speech version of header_text. | +| **tts_description_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing a description for the alert to be used for text-to-speech implementations. This field is the text-to-speech version of description_text.| ## _enum_ Cause From add03b2c45a1344b5242fd71136cfca203d3b739 Mon Sep 17 00:00:00 2001 From: ibi-group-team Date: Mon, 21 Jan 2019 16:45:22 -0500 Subject: [PATCH 5/6] Add more info to field description in reference.md --- gtfs-realtime/proto/gtfs-realtime.proto | 2 +- gtfs-realtime/spec/en/reference.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/gtfs-realtime/proto/gtfs-realtime.proto b/gtfs-realtime/proto/gtfs-realtime.proto index 30b42546..a0ead7e3 100644 --- a/gtfs-realtime/proto/gtfs-realtime.proto +++ b/gtfs-realtime/proto/gtfs-realtime.proto @@ -431,7 +431,7 @@ message Alert { // Text for alert header to be used in text-to-speech implementations. This field is the text-to-speech version of header_text. optional TranslatedString tts_header_text = 12; - //Text for full description for the alert to be used in text-to-speech implementations. This field is the text-to-speech version of description_text. + // Text for full description for the alert to be used in text-to-speech implementations. This field is the text-to-speech version of description_text. optional TranslatedString tts_description_text = 13; // The extensions namespace allows 3rd-party developers to extend the diff --git a/gtfs-realtime/spec/en/reference.md b/gtfs-realtime/spec/en/reference.md index 1bb59214..72e930c8 100644 --- a/gtfs-realtime/spec/en/reference.md +++ b/gtfs-realtime/spec/en/reference.md @@ -265,8 +265,8 @@ An alert, indicating some sort of incident in the public transit network. | **url** | [TranslatedString](#message-translatedstring) | Optional | One | The URL which provides additional information about the alert. | | **header_text** | [TranslatedString](#message-translatedstring) | Required | One | Header for the alert. This plain-text string will be highlighted, for example in boldface. | | **description_text** | [TranslatedString](#message-translatedstring) | Required | One | Description for the alert. This plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user). The information in the description should add to the information of the header. | -| **tts_header_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing the alert's header to be used for text-to-speech implementations. This field is the text-to-speech version of header_text. | -| **tts_description_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing a description for the alert to be used for text-to-speech implementations. This field is the text-to-speech version of description_text.| +| **tts_header_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing the alert's header to be used for text-to-speech implementations. This field is the text-to-speech version of header_text. It should contain the same information as header_text but formatted such that it can read as text-to-speech (for example, abbreviations removed, numbers spelled out, etc.) | +| **tts_description_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing a description for the alert to be used for text-to-speech implementations. This field is the text-to-speech version of description_text. It should contain the same information as description_text but formatted such that it can be read as text-to-speech (for example, abbreviations removed, numbers spelled out, etc.)| ## _enum_ Cause From 87041154eadd09d2e1175e3b40b633703c34951d Mon Sep 17 00:00:00 2001 From: ibi-group-team Date: Wed, 23 Jan 2019 11:55:21 -0500 Subject: [PATCH 6/6] Mark fields as experimental --- gtfs-realtime/proto/gtfs-realtime.proto | 2 ++ gtfs-realtime/spec/en/reference.md | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/gtfs-realtime/proto/gtfs-realtime.proto b/gtfs-realtime/proto/gtfs-realtime.proto index a0ead7e3..401628f9 100644 --- a/gtfs-realtime/proto/gtfs-realtime.proto +++ b/gtfs-realtime/proto/gtfs-realtime.proto @@ -429,9 +429,11 @@ message Alert { optional TranslatedString description_text = 11; // Text for alert header to be used in text-to-speech implementations. This field is the text-to-speech version of header_text. + // This field is still experimental, and subject to change. It may be formally adopted in the future. optional TranslatedString tts_header_text = 12; // Text for full description for the alert to be used in text-to-speech implementations. This field is the text-to-speech version of description_text. + // This field is still experimental, and subject to change. It may be formally adopted in the future. optional TranslatedString tts_description_text = 13; // The extensions namespace allows 3rd-party developers to extend the diff --git a/gtfs-realtime/spec/en/reference.md b/gtfs-realtime/spec/en/reference.md index 72e930c8..be7911f1 100644 --- a/gtfs-realtime/spec/en/reference.md +++ b/gtfs-realtime/spec/en/reference.md @@ -265,8 +265,8 @@ An alert, indicating some sort of incident in the public transit network. | **url** | [TranslatedString](#message-translatedstring) | Optional | One | The URL which provides additional information about the alert. | | **header_text** | [TranslatedString](#message-translatedstring) | Required | One | Header for the alert. This plain-text string will be highlighted, for example in boldface. | | **description_text** | [TranslatedString](#message-translatedstring) | Required | One | Description for the alert. This plain-text string will be formatted as the body of the alert (or shown on an explicit "expand" request by the user). The information in the description should add to the information of the header. | -| **tts_header_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing the alert's header to be used for text-to-speech implementations. This field is the text-to-speech version of header_text. It should contain the same information as header_text but formatted such that it can read as text-to-speech (for example, abbreviations removed, numbers spelled out, etc.) | -| **tts_description_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing a description for the alert to be used for text-to-speech implementations. This field is the text-to-speech version of description_text. It should contain the same information as description_text but formatted such that it can be read as text-to-speech (for example, abbreviations removed, numbers spelled out, etc.)| +| **tts_header_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing the alert's header to be used for text-to-speech implementations. This field is the text-to-speech version of header_text. It should contain the same information as header_text but formatted such that it can read as text-to-speech (for example, abbreviations removed, numbers spelled out, etc.) **Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future. | +| **tts_description_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text containing a description for the alert to be used for text-to-speech implementations. This field is the text-to-speech version of description_text. It should contain the same information as description_text but formatted such that it can be read as text-to-speech (for example, abbreviations removed, numbers spelled out, etc.) **Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future. | ## _enum_ Cause