Skip to content

Commit 474750a

Browse files
authored
Mark images in Service Alerts as final (google#651)
Remove the experimental tag from Alert.image, Alert.image_alternative_text and the TranslatedImage message, in both the .proto and reference.md.
1 parent 3215f98 commit 474750a

2 files changed

Lines changed: 2 additions & 7 deletions

File tree

gtfs-realtime/proto/gtfs-realtime.proto

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -708,12 +708,10 @@ message Alert {
708708

709709
// TranslatedImage to be displayed along the alert text. Used to explain visually the alert effect of a detour, station closure, etc. The image must enhance the understanding of the alert. Any essential information communicated within the image must also be contained in the alert text.
710710
// The following types of images are discouraged : image containing mainly text, marketing or branded images that add no additional information.
711-
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
712711
optional TranslatedImage image = 15;
713712

714713
// Text describing the appearance of the linked image in the `image` field (e.g., in case the image can't be displayed
715714
// or the user can't see the image for accessibility reasons). See the HTML spec for alt image text - https://html.spec.whatwg.org/#alt.
716-
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
717715
optional TranslatedString image_alternative_text = 16;
718716

719717

@@ -1055,7 +1053,6 @@ message TranslatedString {
10551053
// translation, the first matching translation is picked.
10561054
// 3. If some translation has an unspecified language code, that translation is
10571055
// picked.
1058-
// NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
10591056
message TranslatedImage {
10601057
message LocalizedImage {
10611058
// String containing an URL linking to an image

gtfs-realtime/spec/en/reference.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -376,8 +376,8 @@ An alert, indicating some sort of incident in the public transit network.
376376
| **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.) |
377377
| **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.) |
378378
| **severity_level** | [SeverityLevel](#enum-severitylevel) | Optional | One | Severity of the alert. |
379-
| **image** | [TranslatedImage](#message-translatedimage) | Optional | One | TranslatedImage to be displayed along the alert text. Used to explain visually the alert effect of a detour, station closure, etc. The image should enhance the understanding of the alert and must not be the only location of essential information. The following types of images are discouraged : image containing mainly text, marketing or branded images that add no additional information. <br><br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future. |
380-
| **image_alternative_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text describing the appearance of the linked image in the `image` field (e.g., in case the image can't be displayed or the user can't see the image for accessibility reasons). See the HTML [spec for alt image text](https://html.spec.whatwg.org/#alt). <br><br>**Caution:** this field is still **experimental**, and subject to change. It may be formally adopted in the future. |
379+
| **image** | [TranslatedImage](#message-translatedimage) | Optional | One | TranslatedImage to be displayed along the alert text. Used to explain visually the alert effect of a detour, station closure, etc. The image should enhance the understanding of the alert and must not be the only location of essential information. The following types of images are discouraged : image containing mainly text, marketing or branded images that add no additional information. |
380+
| **image_alternative_text** | [TranslatedString](#message-translatedstring) | Optional | One | Text describing the appearance of the linked image in the `image` field (e.g., in case the image can't be displayed or the user can't see the image for accessibility reasons). See the HTML [spec for alt image text](https://html.spec.whatwg.org/#alt). |
381381

382382

383383
## _enum_ Cause
@@ -589,8 +589,6 @@ A localized string mapped to a language.
589589

590590
An internationalized message containing per-language versions of an image. One of the images from a message will be picked up. The resolution proceeds as follows: If the UI language matches the language code of a translation, the first matching translation is picked. If a default UI language (e.g., English) matches the language code of a translation, the first matching translation is picked. If some translation has an unspecified language code, that translation is picked.
591591

592-
**Caution:** this message is still **experimental**, and subject to change. It may be formally adopted in the future.
593-
594592
**Fields**
595593

596594
| _**Field Name**_ | _**Type**_ | _**Required**_ | _**Cardinality**_ | _**Description**_ |

0 commit comments

Comments
 (0)