Skip to content

Commit c7be80f

Browse files
committed
Update in docs
1 parent 47992b6 commit c7be80f

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

documentation/modules/ROOT/pages/datatypes.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,12 @@ definition in the respective standards and an informative description of their v
8989
.3+| Miscellaneous types
9090
| `https://www.w3.org/TR/xmlschema11-2/#anyURI[xsd:anyURI]` | Absolute or relative https://en.wikipedia.org/wiki/Uniform_Resource_Identifier[URI]s and https://en.wikipedia.org/wiki/Internationalized_Resource_Identifier[IRI]s | 'http://example.org/', 'urn:samm:{example-ns}.myapplication:1.0.0#errorState' | {ok}
9191
| `https://www.w3.org/TR/curie/[samm:curie]` | Compact URI/IRI (well-known prefix + element name) | 'xsd:string', 'unit:hectopascal' | {ok}
92-
| `https://www.w3.org/TR/rdf11-concepts/#section-Graph-Literal[rdf:langString]` | Strings with language tags | "Hello"@en, "Hallo"@de. When using `rdf:langString`, a language tag *must always* be provided using the `@` syntax (e.g., `"Hello"@en`).
93-
94-
Using a typed literal form such as `"Hello"^^rdf:langString` is *invalid* and *should cause* the model loading or validation to fail. | {ok}
92+
| `https://www.w3.org/TR/rdf11-concepts/#section-Graph-Literal[rdf:langString]` | Strings with language tags | "Hello"@en, "Hallo"@de. Note that this is written in RDF/Turtle syntax, and that only "Hello" and "Hallo" are the actual values. | {ok}
9593
|===
9694

95+
NOTE: When using `rdf:langString`, a language tag *must always* be provided using the `@` syntax (e.g., `"Hello"@en`).
96+
Using a typed literal form such as `"Hello"^^rdf:langString` is *invalid* and *should cause* the model loading or validation to fail."
97+
9798
The following types defined by the XSD and RDF specifications, respectively, are considered
9899
unsuitable in Aspect Models and _should not_ be used:
99100

documentation/modules/ROOT/pages/modeling-guidelines.adoc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -168,15 +168,14 @@ and value references that point to example values (i.e., references to instances
168168
In either case, the data type of the `samm:exampleValue` must be convertible to the effective data type defined by the Property's Characteristic.
169169
For example, if the Characteristic's `samm:dataType`
170170
is `xsd:int`, a value with the type `xsd:short` is also acceptable. Refer to section xref:datatypes.adoc#implicit-conversions[Implicit Conversions]
171-
for more details.
171+
for more details. | {nok}
172+
|===
172173

173174
When using `rdf:langString`, a language tag *must always* be provided using the `@` syntax, for example:
174175

175-
:x samm:exampleValue "Hello"@en ✔️
176-
:x samm:exampleValue "Hallo"@de ✔️
177-
:x samm:exampleValue "Hello"^^rdf:langString ❌ (invalid — missing language tag)
178-
| {nok}
179-
|===
176+
* `:x samm:exampleValue "Hello"@en` ✔️
177+
* `:x samm:exampleValue "Hallo"@de` ✔️
178+
* `:x samm:exampleValue "Hello"^^rdf:langString` ❌ (invalid — missing language tag)
180179

181180
Example with Literal type:
182181

0 commit comments

Comments
 (0)