AIXM 5 UML package for Notes contains the definition of the generalised notes (remarks) concept. Any AIXM feature can have notes, at two levels:
- concerning the whole feature
- concerning a specified property
Notes may be provided in any language.
The figure below shows that the Note class can be referenced by any AIXMFeature and any AIXMObject.
The Note.purpose attribute may be used to indicate the goal with which a free text Note is provided.
In case the note is related to a specific property, the property name as defined in AIXM 5 shall be provided using the Note.propertyName attribute.
The Note is related to LingusiticNote class which is used for the note content expressed in a specific language.
The text of a Note instance is limited to 10.000 characters.
As a minimum, all Notes shall be expressed in English.
The lang attribute is used to define the language of the Note.
ISO 19115 recommends using ISO 639-2 for language codes. This takes the form of three letters e.g. 'eng'. However, other parts of ISO 639 can be used.
The xml:lang attribute supports supports RFC 3066 and ISO 639. Therefore, it supports 2 letter language codes ('en'), 2 letter codes with country indentification ('en-GB') and 3 letter language identifiers ('eng').
RFC 3066 section 2.3 gives the rules for the choice of language tags. These should be followed to ensure consistency.
| Include Page | ||||
|---|---|---|---|---|
|
Coding Rules for Note
| Identifier | Data Encoding Rule | Justification | Data Verification Rule (UID) | Remarks |
|---|---|---|---|---|
| NTE-101 | For the lang attribute either ISO 639-2 or RFC 3066 standard shall be used. | Data harmonisation | TBD |
...