Skip to content
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

Jump to bottom

Revise SDL-0305 Homogenize TextFieldName #1109

Merged
merged 3 commits into from
Jan 27, 2021
Merged

Revise SDL-0305 Homogenize TextFieldName #1109

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa8a20b
0305 Additionally Remove navigationText
iCollin Dec 16, 2020
7c4aec0
apply revisions from issue 1113
iCollin Jan 27, 2021
b9b79bf
hmi api backticks
iCollin Jan 27, 2021
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
30 changes: 19 additions & 11 deletions proposals/0305-homogenize-textfieldname.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,6 @@ All fields that currently exist only in the `HMI_API.xml` used to also exist in
+
+ <element name="turnText" since="X.X"/>
+ <description>Turn text for turnList parameter of UpdateTurnList</description>
+ </element>
+
+ <element name="navigationText" since="X.X">
+ <description>Navigation text for turnList parameter of UpdateTurnList</description>
+ </element>
</enum>
```
Expand All @@ -46,8 +42,6 @@ All fields that currently exist only in the `HMI_API.xml` used to also exist in

`turnText` is added because it exists in the [`HMI_API.xml`](https://github.com/smartdevicelink/sdl_core/blob/6.1.1/src/components/interfaces/HMI_API.xml#L629) and can be used in the [`UpdateTurnList` RPC](https://smartdevicelink.com/en/docs/hmi/master/navigation/updateturnlist/).

`navigationText` is added because it exists in the [`HMI_API.xml`](https://github.com/smartdevicelink/sdl_core/blob/6.1.1/src/components/interfaces/HMI_API.xml#L630) and can be used in the [`UpdateTurnList` RPC](https://smartdevicelink.com/en/docs/hmi/master/navigation/updateturnlist/).

#### HMI_API.xml

```xml
Expand All @@ -65,21 +59,35 @@ All fields that currently exist only in the `HMI_API.xml` used to also exist in
+ <element name="turnText">
+ <description>Turn text for turnList parameter of UpdateTurnList</description>
+ </element>
<element name="navigationText">
<description>Navigation text for turnList parameter of UpdateTurnList</description>
</element>
- <element name="navigationText">
- <description>Navigation text for turnList parameter of UpdateTurnList</description>
- </element>
- <element name="notificationText">
- <description>Text of notification to be displayed on screen.</description>
- </element>
</enum>
...
<struct name="Turn">
<param name="navigationText" type="Common.TextFieldStruct" mandatory="false">
- <description>Uses navigationText from TextFieldStruct.</description>
+ <description>Describes the turn using TextFieldName turnText</description>
iCollin marked this conversation as resolved.
Show resolved Hide resolved
</param>
<param name="turnIcon" type="Common.Image" mandatory="false">
</param>
</struct>
```

`notificationText` is removed because it does not exist in the `MOBILE_API.xml` and is not used currently.
`navigationText` is removed because it does not exist in the `MOBILE_API.xml` and is not used currently.

The comment `<!-- TO DO to be removed -->` is removed because it is no longer relevant.

Descriptions are added to both `timeToDestination` and `turnText`.

#### HMI Integration Guidelines

Clarify that `UpdateTurnList` is using `fieldName` `turnText` within `TextField` parameter `navigationText`.

## Potential downsides

The author doesn't know of any downsides to this proposal.
Expand All @@ -88,10 +96,10 @@ The author doesn't know of any downsides to this proposal.

The `MOBILE_API.xml` changes will have no impact on existing code as only additions are made.

The `HMI_API.xml` changes will require updates to HMIs to remove `notificationText` from their capabilities and an update to Core to remove the processing of the `notificationText` `TextFieldName` capability.
The `HMI_API.xml` changes will require updates to HMIs to remove `notificationText` and `navigationText` from their capabilities and an update to Core to remove the processing of the `notificationText` and `navigationText` `TextFieldName` capabilities.

## Alternatives considered

The author considered making no changes to the spec but this would be confusing to developers and would cause problems when another element is added to the `TextFieldName` enum.

The author considered not removing `notificationText` but this solution would also cause problems when another element is added to the `TextFieldName` enum.
The author considered not removing `notificationText` or `navigationText` but this solution would also cause problems when another element is added to the `TextFieldName` enum.