Skip to content

Proposal: Alert tts_header_text, tts_description_text no longer experimental #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
barbeau merged 1 commit into from
Jul 23, 2020
Merged

Proposal: Alert tts_header_text, tts_description_text no longer experimental #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions gtfs-realtime/proto/gtfs-realtime.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,11 +470,9 @@ 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;

// Severity of this alert.
Expand Down
4 changes: 2 additions & 2 deletions gtfs-realtime/spec/en/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,8 +273,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.) **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. |
| **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.) |
| **severity_level** | [SeverityLevel](#enum-severitylevel) | Optional | One | Severity of the alert. |

## _enum_ Cause
Expand Down