Skip to content

Commit

Permalink
Point in time -> temporal value
Browse files Browse the repository at this point in the history
  • Loading branch information
@HeikoTheissen
HeikoTheissen committed Jul 25, 2024
1 parent e95d602 commit 9fbcf87
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions vocabularies/UI.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1311,8 +1311,8 @@
"$Type": "UI.DateTimeFormatType",
"$AppliesTo": ["Property", "Parameter"],
"@Common.Experimental": true,
"@Core.Description": "The point in time represented by the annotated property or parameter shall be shown on the UI in the given format",
"@Core.LongDescription": "Requires type `Edm.Date`, `Edm.TimeOfDay`, or `Edm.DateTimeOffset`.\n If this annotation is absent or all its properties null or an empty string, points in time are shown in a default format."
"@Core.Description": "The temporal value represented by the annotated property or parameter shall be shown on the UI in the given format",
"@Core.LongDescription": "Requires type `Edm.Date`, `Edm.TimeOfDay`, or `Edm.DateTimeOffset`.\n If this annotation is absent or all its properties null or an empty string, temporal values are shown in a default format."
},
"DateTimeFormatType": {
"$Kind": "ComplexType",
Expand All @@ -1323,7 +1323,7 @@
},
"Style": {
"$Nullable": true,
"@Core.Description": "Show the point in time in shorter or longer style",
"@Core.Description": "Show the temporal value in shorter or longer style",
"@Validation.AllowedValues": [
{ "Value": "short", "@Core.Description": "7/25/24, 1:11 PM" },
{ "Value": "medium", "@Core.Description": "Jul 25, 2024, 1:11:51 PM" },
Expand Down
4 changes: 2 additions & 2 deletions vocabularies/UI.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Term|Type|Description
[Placeholder](UI.xml#L1402)|String|<a name="Placeholder"></a>A short, human-readable text that gives a hint or an example to help the user with data entry
[InputMask](UI.xml#L1407) *([Experimental](Common.md#Experimental))*|[InputMaskType](#InputMaskType)|<a name="InputMask"></a>Properties or parameters annotated with this term will get a mask in edit mode<br>Input masks improve readability and help to enter data correctly. So, masks can be especially useful for input fields that have a fixed pattern, e.g. DUNS numbers or similar. [Here](../examples/UI.InputMask-sample.xml) you can find an example for this annotation
[TextArrangement](UI.xml#L1441)|[TextArrangementType](#TextArrangementType)|<a name="TextArrangement"></a>Describes the arrangement of a code or ID value and its text<br><p>This term annotates one of the following:</p> <ol type="1"> <li>a <a href="Common.md#Text"><code>Common.Text</code></a> annotation of the code or ID property where the annotation value is the text</li> <li>an entity type, this has the same effect as annotating all <code>Common.Text</code> annotations of properties of that entity type.</li> </ol>
[DateTimeFormat](UI.xml#L1464) *([Experimental](Common.md#Experimental))*|[DateTimeFormatType](#DateTimeFormatType)|<a name="DateTimeFormat"></a>The point in time represented by the annotated property or parameter shall be shown on the UI in the given format<br>Requires type `Edm.Date`, `Edm.TimeOfDay`, or `Edm.DateTimeOffset`. If this annotation is absent or all its properties null or an empty string, points in time are shown in a default format.
[DateTimeFormat](UI.xml#L1464) *([Experimental](Common.md#Experimental))*|[DateTimeFormatType](#DateTimeFormatType)|<a name="DateTimeFormat"></a>The temporal value represented by the annotated property or parameter shall be shown on the UI in the given format<br>Requires type `Edm.Date`, `Edm.TimeOfDay`, or `Edm.DateTimeOffset`. If this annotation is absent or all its properties null or an empty string, temporal values are shown in a default format.
[Note](UI.xml#L1502) *([Experimental](Common.md#Experimental))*|[NoteType](#NoteType)|<a name="Note"></a>Visualization of a note attached to an entity<br>Administrative data is given by the annotations [`Common.CreatedBy`](Common.md#CreatedBy), [`Common.CreatedAt`](Common.md#CreatedAt), [`Common.ChangedBy`](Common.md#ChangedBy), [`Common.ChangedAt`](Common.md#ChangedAt) on the same entity type.
[Importance](UI.xml#L1555)|[ImportanceType](#ImportanceType)|<a name="Importance"></a>Expresses the importance of e.g. a DataField or an annotation
[Hidden](UI.xml#L1570)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|<a name="Hidden"></a>Properties or facets (see UI.Facet) annotated with this term will not be rendered if the annotation evaluates to true.<br>Hidden properties usually carry technical information that is used for application control and is of no direct interest to end users. The annotation value may be an expression to dynamically hide or render the annotated feature. If a navigation property is annotated with `Hidden` true, all subsequent parts are hidden - independent of their own potential `Hidden` annotations.
Expand Down Expand Up @@ -792,7 +792,7 @@ Member|Value|Description
Property|Type|Description
:-------|:---|:----------
[Pattern](UI.xml#L1474)|String?|A date/time pattern as defined in https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table
[Style](UI.xml#L1477)|String?|Show the point in time in shorter or longer style<dl>Allowed values:<dt>[short](UI.xml#L1481)<dd>7/25/24, 1:11 PM<dt>[medium](UI.xml#L1485)<dd>Jul 25, 2024, 1:11:51 PM<dt>[long](UI.xml#L1489)<dd>July 25, 2024 at 1:11:51 PM GMT+2<dt>[full](UI.xml#L1493)<dd>Thursday, July 25, 2024 at 1:11:51 PM Central European Summer Time</dl>
[Style](UI.xml#L1477)|String?|Show the temporal value in shorter or longer style<dl>Allowed values:<dt>[short](UI.xml#L1481)<dd>7/25/24, 1:11 PM<dt>[medium](UI.xml#L1485)<dd>Jul 25, 2024, 1:11:51 PM<dt>[long](UI.xml#L1489)<dd>July 25, 2024 at 1:11:51 PM GMT+2<dt>[full](UI.xml#L1493)<dd>Thursday, July 25, 2024 at 1:11:51 PM Central European Summer Time</dl>

<a name="NoteType"></a>
## [NoteType](UI.xml#L1514) *([Experimental](Common.md#Experimental))*
Expand Down
6 changes: 3 additions & 3 deletions vocabularies/UI.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1463,10 +1463,10 @@ So, masks can be especially useful for input fields that have a fixed pattern, e

<Term Name="DateTimeFormat" Type="UI.DateTimeFormatType" Nullable="false" AppliesTo="Property Parameter">
<Annotation Term="Common.Experimental" />
<Annotation Term="Core.Description" String="The point in time represented by the annotated property or parameter shall be shown on the UI in the given format" />
<Annotation Term="Core.Description" String="The temporal value represented by the annotated property or parameter shall be shown on the UI in the given format" />
<Annotation Term="Core.LongDescription">
<String>Requires type `Edm.Date`, `Edm.TimeOfDay`, or `Edm.DateTimeOffset`.
If this annotation is absent or all its properties null or an empty string, points in time are shown in a default format.</String>
If this annotation is absent or all its properties null or an empty string, temporal values are shown in a default format.</String>
</Annotation>
</Term>
<ComplexType Name="DateTimeFormatType">
Expand All @@ -1475,7 +1475,7 @@ So, masks can be especially useful for input fields that have a fixed pattern, e
<Annotation Term="Core.Description" String="A date/time pattern as defined in https://unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table" />
</Property>
<Property Name="Style" Type="Edm.String" Nullable="true">
<Annotation Term="Core.Description" String="Show the point in time in shorter or longer style" />
<Annotation Term="Core.Description" String="Show the temporal value in shorter or longer style" />
<Annotation Term="Validation.AllowedValues">
<Collection>
<Record>
Expand Down

0 comments on commit 9fbcf87

Please sign in to comment.