diff --git a/dmlex-v1.0/specification/core/objectTypes/definition.xml b/dmlex-v1.0/specification/core/objectTypes/definition.xml index a9ed3a1d..5a19b52e 100644 --- a/dmlex-v1.0/specification/core/objectTypes/definition.xml +++ b/dmlex-v1.0/specification/core/objectTypes/definition.xml @@ -24,18 +24,18 @@ Properties text - required (exactly one) and UNIQUE. Non-empty string. A statement, in the same - language as the headword, that describes and/or explains the meaning of a sense. In DMLex, - the term definition encompasses not only formal definitions, but also less formal - explanations. + required (exactly one) and UNIQUE. Normalised + string. A statement, in the same language as the headword, that describes and/or explains + the meaning of a sense. In DMLex, the term definition encompasses not only formal + definitions, but also less formal explanations. definitionType - optional (zero or one). If a sense contains multiple definitions, - indicates the difference between them, for example that they are intended for different - audiences. The definitionTypeTag object type can be used - to constrain and/or explain the definition types that occur in the lexicographic - resource. + optional (zero or one). Normalised string. If a sense contains + multiple definitions, indicates the difference between them, for example that they are + intended for different audiences. The definitionTypeTag object type can be used to constrain and/or explain + the definition types that occur in the lexicographic resource. listingOrder @@ -47,7 +47,9 @@ XML -<definition definitionType="...">...</definition> +<definition definitionType="..."> + <text>...</text> +</definition> diff --git a/dmlex-v1.0/specification/core/objectTypes/entry.xml b/dmlex-v1.0/specification/core/objectTypes/entry.xml index cb06e279..7cdbae03 100644 --- a/dmlex-v1.0/specification/core/objectTypes/entry.xml +++ b/dmlex-v1.0/specification/core/objectTypes/entry.xml @@ -24,12 +24,15 @@ Properties headword - required (exactly one) and unique (in combination with other unique properties if present). Non-empty string. The entry's + required (exactly one) and unique (in + combination with other unique properties if present). Normalised string. The entry's headword. homographNumber - optional (zero or one) and unique (in combination with other unique properties if present). The entry's homograph number, as a guide to distinguish entries with the same headword. + optional (zero or one) and unique (in + combination with other unique properties if present). Number. The entry's homograph number, + as a guide to distinguish entries with the same headword. partOfSpeech diff --git a/dmlex-v1.0/specification/core/objectTypes/example.xml b/dmlex-v1.0/specification/core/objectTypes/example.xml index ca009ebe..934c6dbd 100644 --- a/dmlex-v1.0/specification/core/objectTypes/example.xml +++ b/dmlex-v1.0/specification/core/objectTypes/example.xml @@ -25,20 +25,22 @@ Properties text - required (exactly one) and unique. Non-empty string. The example itself. + required (exactly one) and unique. Normalised + string. The example itself. sourceIdentity - optional (zero or one). An abbreviation, a code or some other string - of text which identifies the source. The sourceIdentityTag object type can be used to explain the meaning of the source - identifiers, to constrain which source identifiers are allowed to occur in the lexicographic - resource, and to map them onto external inventories and ontologies. + optional (zero or one). Normalised string. An abbreviation, a code or + some other string of text which identifies the source. The sourceIdentityTag object type can be + used to explain the meaning of the source identifiers, to constrain which source identifiers + are allowed to occur in the lexicographic resource, and to map them onto external + inventories and ontologies. sourceElaboration - optional (zero or one). Non-empty string. A free-form statement about - the source of the example. If sourceIdentity is present, then + optional (zero or one). Normalised string. A free-form statement + about the source of the example. If sourceIdentity is present, then sourceElaboration can be used for information about where in the source the example can be found: page number, chapter and so on. If sourceIdentity is absent then sourceElaboration can be used to fully name the source. @@ -49,8 +51,9 @@ soundFile - optional (zero or one). A pointer to a file, such as a filename or a URI, containing a sound recording of the - example. + optional (zero or one). An Internationalized Resource + Identifier (IRI) pointing to a file which + contains a sound recording of the example. listingOrder diff --git a/dmlex-v1.0/specification/core/objectTypes/inflectedForm.xml b/dmlex-v1.0/specification/core/objectTypes/inflectedForm.xml index 52129ab9..c3bc7a76 100644 --- a/dmlex-v1.0/specification/core/objectTypes/inflectedForm.xml +++ b/dmlex-v1.0/specification/core/objectTypes/inflectedForm.xml @@ -25,18 +25,20 @@ Properties text - required (exactly one) and unique (in combination with other unique properties if present). Non-empty string. The text of the inflected - form. + required (exactly one) and unique (in + combination with other unique properties if present). Normalised string. The text of the + inflected form. tag - optional (zero or one) and unique (in combination with other unique properties if present). Non-empty string. An abbreviation, a code or - some other string of text which identifies the inflected form, for example pl - for plural, gs for genitive singular, com for comparative. The - inflectedFormTag object - type can be used to explain the meaning of the inflection tags, to constrain which - inflection tags are allowed to occur in the lexicographic resource, and to map them onto - external inventories and ontologies. + optional (zero or one) and unique (in + combination with other unique properties if present). Normalised string. An abbreviation, a + code or some other string of text which identifies the inflected form, for example + pl for plural, gs for genitive singular, com for + comparative. The inflectedFormTag object type can be used to explain the meaning of the + inflection tags, to constrain which inflection tags are allowed to occur in the + lexicographic resource, and to map them onto external inventories and ontologies. label diff --git a/dmlex-v1.0/specification/core/objectTypes/label.xml b/dmlex-v1.0/specification/core/objectTypes/label.xml index 2fdce23c..5a0535a6 100644 --- a/dmlex-v1.0/specification/core/objectTypes/label.xml +++ b/dmlex-v1.0/specification/core/objectTypes/label.xml @@ -38,12 +38,13 @@ Properties tag - required (exactly one) and unique. Non-empty string. An abbreviation, a code or - some other string of text which identifies the label, for example neo for - neologism, colloq for colloquial, polit for politics. The - labelTag object type can be used to explain - the meaning of the labels, to constrain which labels are allowed to occur in the - lexicographic resource, and to map them onto external inventories and ontologies. + required (exactly one) and unique. Normalised + string. An abbreviation, a code or some other string of text which identifies the label, for + example neo for neologism, colloq for colloquial, + polit for politics. The labelTag object type can be used to explain the meaning of the labels, + to constrain which labels are allowed to occur in the lexicographic resource, and to map + them onto external inventories and ontologies. listingOrder diff --git a/dmlex-v1.0/specification/core/objectTypes/lexicographicResource.xml b/dmlex-v1.0/specification/core/objectTypes/lexicographicResource.xml index 70dcfb09..23bd04d6 100644 --- a/dmlex-v1.0/specification/core/objectTypes/lexicographicResource.xml +++ b/dmlex-v1.0/specification/core/objectTypes/lexicographicResource.xml @@ -23,7 +23,7 @@ Properties title - optional (zero or one). Non-empty string. A human-readable title of + optional (zero or one). Normalised string. A human-readable title of the lexicographic resource. diff --git a/dmlex-v1.0/specification/core/objectTypes/partOfSpeech.xml b/dmlex-v1.0/specification/core/objectTypes/partOfSpeech.xml index 7fadaf9c..c39f0ce4 100644 --- a/dmlex-v1.0/specification/core/objectTypes/partOfSpeech.xml +++ b/dmlex-v1.0/specification/core/objectTypes/partOfSpeech.xml @@ -24,13 +24,13 @@ Properties tag - required (exactly one) and unique. Non-empty string. An abbreviation, a code or - some other string of text which identifies the part-of-speech label, for example - n for noun, v for verb, adj for adjective. The - partOfSpeechTag object type can be used to explain - the meaning of the part-of-speech tags, to constrain which part-of-speech tags are allowed - to occur in the lexicographic resource, and to map them onto external inventories and - ontologies. + required (exactly one) and unique. Normalised + string. An abbreviation, a code or some other string of text which identifies the + part-of-speech label, for example n for noun, v for verb, + adj for adjective. The partOfSpeechTag object type can be used to explain the meaning of the + part-of-speech tags, to constrain which part-of-speech tags are allowed to occur in the + lexicographic resource, and to map them onto external inventories and ontologies. listingOrder diff --git a/dmlex-v1.0/specification/core/objectTypes/pronunciation.xml b/dmlex-v1.0/specification/core/objectTypes/pronunciation.xml index 23f0526e..58e03ee5 100644 --- a/dmlex-v1.0/specification/core/objectTypes/pronunciation.xml +++ b/dmlex-v1.0/specification/core/objectTypes/pronunciation.xml @@ -36,7 +36,8 @@ transcription - optional (zero or more) and unique. + optional (zero or more) and unique. + Normalised string. diff --git a/dmlex-v1.0/specification/core/objectTypes/sense.xml b/dmlex-v1.0/specification/core/objectTypes/sense.xml index b4f40bd8..413469db 100644 --- a/dmlex-v1.0/specification/core/objectTypes/sense.xml +++ b/dmlex-v1.0/specification/core/objectTypes/sense.xml @@ -29,10 +29,11 @@ indicator - optional (zero or one) and unique. A short statement, in the same language as - the headword, that gives an indication of the meaning of a sense and permits its - differentiation from other senses in the entry. Indicators are sometimes used in - dictionaries instead of or in addition to definitions. + optional (zero or one) and unique. Normalised + string. A short statement, in the same language as the headword, that gives an indication of + the meaning of a sense and permits its differentiation from other senses in the entry. + Indicators are sometimes used in dictionaries instead of or in addition to + definitions. label diff --git a/dmlex-v1.0/specification/core/objectTypes/transcription.xml b/dmlex-v1.0/specification/core/objectTypes/transcription.xml index d431e1ec..2c39f70c 100644 --- a/dmlex-v1.0/specification/core/objectTypes/transcription.xml +++ b/dmlex-v1.0/specification/core/objectTypes/transcription.xml @@ -24,8 +24,8 @@ Properties text - required (exactly one) and unique. Non-empty string. The actual - transcription. + required (exactly one) and unique. Normalised + string. The actual transcription. scheme @@ -47,7 +47,9 @@ XML -<transcription scheme="...">...</transcription> +<transcription scheme="..."> + <text>...</text> +</transcription> diff --git a/dmlex-v1.0/specification/dmlex.xml b/dmlex-v1.0/specification/dmlex.xml index 4ffc775b..2d4c457d 100644 --- a/dmlex-v1.0/specification/dmlex.xml +++ b/dmlex-v1.0/specification/dmlex.xml @@ -345,7 +345,7 @@ including all the modules. An object type defined in one module is guaranteed not to name-conflict with another object type in another module. -
+
Properties For every object type, DMLex defines which properties it can have, whether the properties are required or optional, what their arities are (for example “zero or more”), and what @@ -353,13 +353,33 @@ There are two kinds of properties: those that contain literal values and those that contain objects. Some properties are defined to contain literal values such as strings and numbers. The - following types of literal values are used in DMLex: - non-empty string, - number, - unique identifier - and reference to a unique identifier - - + following types of literal values are used in DMLex: + + + normalised string: a string that contains no new lines, does not start or end with a whitespace, contains no block of ASCII whitespace more than a single space and is non-empty. + + + number: including negative numbers and floating-point numbers + + + non-negative integer number + + + boolean: a true/false value + + + URI + + + IETF language code + + + IRI: an Internationalized Resource Identifier + + + closed list of possible values + + Some properties are defined to contain objects (of types defined in DMLex), for example an object of type entry can contain objects of type sense. In such cases, the name of the property is the same as the name of diff --git a/dmlex-v1.0/specification/examples/examples/source/0.xml.xml b/dmlex-v1.0/specification/examples/examples/source/0.xml.xml index 72907c71..e875cc06 100644 --- a/dmlex-v1.0/specification/examples/examples/source/0.xml.xml +++ b/dmlex-v1.0/specification/examples/examples/source/0.xml.xml @@ -4,8 +4,9 @@ <headword>abandon</headword> <partOfSpeech tag="verb"/> <sense id="abandon-verb-1"> - <definition>to suddenly leave a place or a person</definition> - + <definition> + <text>to suddenly leave a place or a person</text> + </definition> <example> <text>I'm sorry I abandoned you like that.</text> </example> @@ -16,7 +17,9 @@ </sense> <sense id="abandon-verb-2"> <label tag="mostly-passive"/> - <definition>to stop supporting an idea</definition> + <definition> + <text>to stop supporting an idea</text> + </definition> <example> <text>That theory has been abandoned.</text> </example> diff --git a/dmlex-v1.0/specification/examples/examples/source/12.xml.xml b/dmlex-v1.0/specification/examples/examples/source/12.xml.xml index 3d368052..389a7534 100644 --- a/dmlex-v1.0/specification/examples/examples/source/12.xml.xml +++ b/dmlex-v1.0/specification/examples/examples/source/12.xml.xml @@ -3,14 +3,16 @@ <entry id="glasses"> <headword>glasses</headword> <sense id="glasses-1"> - <definition>an optical seeing aid</definition> + <definition> + <text>an optical seeing aid</text> + </definition> </sense> </entry> <entry id="microscope"> <headword>microscope</headword> <sense id="microscope-1"> <definition> - equipment for looking at very small things + <text>equipment for looking at very small things</text> </definition> </sense> </entry> @@ -18,7 +20,7 @@ <headword>lens</headword> <sense id="lens-1"> <definition> - curved glass that makes things seem bigger + <text>curved glass that makes things seem bigger</text> </definition> </sense> </entry> diff --git a/dmlex-v1.0/specification/examples/examples/source/13.xml.xml b/dmlex-v1.0/specification/examples/examples/source/13.xml.xml index e771d416..df8cc346 100644 --- a/dmlex-v1.0/specification/examples/examples/source/13.xml.xml +++ b/dmlex-v1.0/specification/examples/examples/source/13.xml.xml @@ -3,13 +3,17 @@ <entry id="buy"> <headword>buy</headword> <sense id="buy-1"> - <definition>get something by paying money for it</definition> + <definition> + <text>get something by paying money for it</text> + </definition> </sense> </entry> <entry id="sell"> <headword>sell</headword> <sense id="sell-1"> - <definition>exchange something for money</definition> + <definition> + <text>exchange something for money</text> + </definition> </sense> </entry> <relation type="antonyms"> diff --git a/dmlex-v1.0/specification/examples/examples/source/15.xml.xml b/dmlex-v1.0/specification/examples/examples/source/15.xml.xml index ec4285ad..858e1d06 100644 --- a/dmlex-v1.0/specification/examples/examples/source/15.xml.xml +++ b/dmlex-v1.0/specification/examples/examples/source/15.xml.xml @@ -5,9 +5,12 @@ <partOfSpeech tag="n"/> <label tag="europeanSpelling"/> <sense id="colour-1"> - <definition>red, blue, yellow etc.</definition> - <example><text>What is your favourite colour?</text></example> - + <definition> + <text>red, blue, yellow etc.</text> + </definition> + <example> + <text>What is your favourite colour?</text> + </example> </sense> </entry> <entry id="color"> diff --git a/dmlex-v1.0/specification/examples/examples/source/16.xml.xml b/dmlex-v1.0/specification/examples/examples/source/16.xml.xml index 9a57795c..6eac67d2 100644 --- a/dmlex-v1.0/specification/examples/examples/source/16.xml.xml +++ b/dmlex-v1.0/specification/examples/examples/source/16.xml.xml @@ -3,25 +3,33 @@ <entry id="colour"> <headword>colour</headword> <sense id="colour-1"> - <definition>red, blue, yellow etc.</definition> + <definition> + <text>red, blue, yellow etc.</text> + </definition> <example> <text>What is your favourite colour?</text> </example> </sense> <sense id="colour-2"> - <definition>not being black and white</definition> + <definition> + <text>not being black and white</text> + </definition> <example> <text>Owning a colour TV meant you were rich.</text> </example> </sense> <sense id="colour-3"> - <definition>a sign of a person's race</definition> + <definition> + <text>a sign of a person's race</text> + </definition> <example> <text>People of all creeds and colours.</text> </example> </sense> <sense id="colour-4"> - <definition>interest or excitement</definition> + <definition> + <text>interest or excitement</text> + </definition> <example> <text>Examples add colour to your writing.</text> </example> diff --git a/dmlex-v1.0/specification/examples/examples/source/17.xml.xml b/dmlex-v1.0/specification/examples/examples/source/17.xml.xml index 1b00a046..14316ab5 100644 --- a/dmlex-v1.0/specification/examples/examples/source/17.xml.xml +++ b/dmlex-v1.0/specification/examples/examples/source/17.xml.xml @@ -19,7 +19,7 @@ <headword>better safe than sorry</headword> <sense id="better-safe-1"> <definition> - you should be careful even if it seems unnecessary + <text>you should be careful even if it seems unnecessary</text> </definition> </sense> </entry> diff --git a/dmlex-v1.0/specification/examples/examples/source/18.xml.xml b/dmlex-v1.0/specification/examples/examples/source/18.xml.xml index 95dfe493..b3cd1eae 100644 --- a/dmlex-v1.0/specification/examples/examples/source/18.xml.xml +++ b/dmlex-v1.0/specification/examples/examples/source/18.xml.xml @@ -4,7 +4,7 @@ <headword>the Bible</headword> <sense id="the-bible-1"> <definition> - the book considered holy by Christians + <text>the book considered holy by Christians</text> </definition> </sense> </entry> @@ -13,7 +13,7 @@ <sense id="bible-1"/> <sense id="bible-2"> <definition> - a book considered important for a subject + <text>a book considered important for a subject</text> </definition> </sense> </entry> diff --git a/dmlex-v1.0/specification/examples/examples/source/2.xml.xml b/dmlex-v1.0/specification/examples/examples/source/2.xml.xml index 7733fb88..65afdffc 100644 --- a/dmlex-v1.0/specification/examples/examples/source/2.xml.xml +++ b/dmlex-v1.0/specification/examples/examples/source/2.xml.xml @@ -2,7 +2,9 @@ <entry id="aardvark-noun"> <headword>aardvark</headword> <pronunciation> - <transcription>a:rdva:rk</transcription> + <transcription> + <text>a:rdva:rk</text> + </transcription> </pronunciation> </entry> diff --git a/dmlex-v1.0/specification/examples/examples/source/4.xml.xml b/dmlex-v1.0/specification/examples/examples/source/4.xml.xml index 3e7bca2a..08afa857 100644 --- a/dmlex-v1.0/specification/examples/examples/source/4.xml.xml +++ b/dmlex-v1.0/specification/examples/examples/source/4.xml.xml @@ -2,7 +2,9 @@ <entry id="aardvark-noun"> <headword>aardvark</headword> <pronunciation soundFile="aardvark.mp3"> - <transcription>a:rdva:rk</transcription> + <transcription> + <text>a:rdva:rk</text> + </transcription> </pronunciation> </entry> diff --git a/dmlex-v1.0/specification/examples/examples/source/9.xml.xml b/dmlex-v1.0/specification/examples/examples/source/9.xml.xml index 7194058b..cf4c789a 100644 --- a/dmlex-v1.0/specification/examples/examples/source/9.xml.xml +++ b/dmlex-v1.0/specification/examples/examples/source/9.xml.xml @@ -3,8 +3,12 @@ <headword>Treppenwitz</headword> <partOfSpeech tag="n-masc"/> <sense id="treppenwitz-1"> - <headwordExplanation langCode="en">belated realisation of what one - could have said</headwordExplanation> + <headwordExplanation langCode="en"> + <text> + belated realisation of what one + could have said + </text> + </headwordExplanation> <headwordTranslation langCode="en"> <text>staircase wit</text> </headwordTranslation> diff --git a/dmlex-v1.0/specification/modules/annotation/extensions/definition.xml b/dmlex-v1.0/specification/modules/annotation/extensions/definition.xml index 882dd5bc..c23acc48 100644 --- a/dmlex-v1.0/specification/modules/annotation/extensions/definition.xml +++ b/dmlex-v1.0/specification/modules/annotation/extensions/definition.xml @@ -29,11 +29,13 @@ XML <definition...> + <text> ... <headwordMarker>...</headwordMarker> ... <collocateMarker...>...</collocateMarker> ... + </text> </definition> diff --git a/dmlex-v1.0/specification/modules/annotation/objectTypes/collocateMarker.xml b/dmlex-v1.0/specification/modules/annotation/objectTypes/collocateMarker.xml index 16ed2fc0..f7b9b7d5 100644 --- a/dmlex-v1.0/specification/modules/annotation/objectTypes/collocateMarker.xml +++ b/dmlex-v1.0/specification/modules/annotation/objectTypes/collocateMarker.xml @@ -29,17 +29,21 @@ Properties - startIndex (required). Non-negative integer. The index of the first character of the substring - according to the number of Unicode code points. The first character of the string has index - 0. This property may be implicit if using in-line markup. + startIndex + required and unique. Non-negative integer. The + index of the first character of the substring according to the number of Unicode code + points. The first character of the string has index 0. This property may be implicit if + using in-line markup. - endIndex (required). Non-negative integer. The index of the last character after the substring - according to the number of Unicode code points. This property may be implicit if using in-line markup + endIndex + required and unique. Non-negative integer. The + index of the last character after the substring according to the number of Unicode code + points. This property may be implicit if using in-line markup lemma - optional (zero or one) and unique. Non-empty string. The lemmatized form of the + optional (zero or one). Normalised string. The lemmatized form of the collocate. An application can use it to provide a clickable link for the user to search for the lemma in the rest of the lexicographic resource or on the web. (If you want to link the collocate explicitly to a specific entry or to a specific sense in your lexicographic diff --git a/dmlex-v1.0/specification/modules/etymology/objectTypes/etymology.xml b/dmlex-v1.0/specification/modules/etymology/objectTypes/etymology.xml index fdec66e5..97d52c50 100644 --- a/dmlex-v1.0/specification/modules/etymology/objectTypes/etymology.xml +++ b/dmlex-v1.0/specification/modules/etymology/objectTypes/etymology.xml @@ -24,9 +24,10 @@ description - optional (zero or one) and unique. A plain-text form of the etymology, which may - contain notes about the etymology. This may be used instead of or alongside a structured list of - origin and etymon objects. + optional (zero or one) and unique. + Normalised string. A plain-text form of the etymology, which may contain notes about the + etymology. This may be used instead of or alongside a structured list of origin and + etymon objects. etymon diff --git a/dmlex-v1.0/specification/modules/etymology/objectTypes/etymon.xml b/dmlex-v1.0/specification/modules/etymology/objectTypes/etymon.xml index 408bfb98..8d364926 100644 --- a/dmlex-v1.0/specification/modules/etymology/objectTypes/etymon.xml +++ b/dmlex-v1.0/specification/modules/etymology/objectTypes/etymon.xml @@ -23,22 +23,23 @@ Properties when - optional (zero or one) and unique (in combination with other unique properties if present). Indicates the time period during which this etymological origin is valid. - The value is an open-text indication of the time period, in the language of the dictionary. - + optional (zero or one) and unique (in + combination with other unique properties if present). Normalised string. Indicates + the time period during which this etymological origin is valid. The value is an + open-text indication of the time period, in the language of the dictionary. type - optional (zero or one). The type of the etymological process - that occurred at this stage of the headword's etymological history such as - derivation, cognate, borrowing. The values can be explained and constrained using - the etymonType - object type. + optional (zero or one). Normalised string. The type of the + etymological process that occurred at this stage of the headword's etymological + history such as derivation, cognate, borrowing. The values can be explained and + constrained using the etymonType object type. note - optional (zero or one). Any additional information about this stage - of the headword's etymological history. + optional (zero or one). Normalised string. Any additional + information about this stage of the headword's etymological history. etymonUnit @@ -46,7 +47,8 @@ translation - optional (zero or one). A translation or gloss of the etymon in the language of the lexicographic resource. + optional (zero or one). Normalised string. A translation or + gloss of the etymon in the language of the lexicographic resource. listingOrder diff --git a/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonLanguage.xml b/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonLanguage.xml index 4a9344fc..39a60481 100644 --- a/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonLanguage.xml +++ b/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonLanguage.xml @@ -29,7 +29,8 @@ displayName - optional (zero or one). The name of the etymon language, in the language of the lexicographic resource. + optional (zero or one). Normalised string. The name of the etymon + language, in the language of the lexicographic resource. diff --git a/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonType.xml b/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonType.xml index 9ba4c433..058c0973 100644 --- a/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonType.xml +++ b/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonType.xml @@ -23,11 +23,12 @@ Properties type - required (exactly one) and unique. Non-empty string. + required (exactly one) and unique. + Normalised string. description - optional (zero or one). Non-empty string. A human-readable + optional (zero or one). Normalised string. A human-readable explanation of this type. diff --git a/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonUnit.xml b/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonUnit.xml index 6b124206..4f1e680c 100644 --- a/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonUnit.xml +++ b/dmlex-v1.0/specification/modules/etymology/objectTypes/etymonUnit.xml @@ -30,8 +30,9 @@ text - required (exactly one) and unique (in combination with other unique properties if present). The written form of the - etymon. + required (exactly one) and unique (in + combination with other unique properties if present). Normalised string. The written + form of the etymon. reconstructed @@ -44,7 +45,8 @@ translation - optional (zero or one). A translation or gloss of the etymon in the language of the lexicographic resource. + optional (zero or one). Normalised string. A translation or + gloss of the etymon in the language of the lexicographic resource. listingOrder diff --git a/dmlex-v1.0/specification/modules/linking/objectTypes/member.xml b/dmlex-v1.0/specification/modules/linking/objectTypes/member.xml index 297f7548..6bfdcca5 100644 --- a/dmlex-v1.0/specification/modules/linking/objectTypes/member.xml +++ b/dmlex-v1.0/specification/modules/linking/objectTypes/member.xml @@ -28,8 +28,9 @@ role - optional (zero or one) and unique (in combination with other unique properties if present). Non-empty string. An indication of the role - the member has in this relation: whether it is the hypernym or the hyponym (in a + optional (zero or one) and unique (in + combination with other unique properties if present). Normalised string. An indication of + the role the member has in this relation: whether it is the hypernym or the hyponym (in a hyperonymy/hyponymy relation), or whether it is one of the synonyms (in a synonymy relation), and so on. You can use memberType objects to explain those roles and to constrain which diff --git a/dmlex-v1.0/specification/modules/linking/objectTypes/memberType.xml b/dmlex-v1.0/specification/modules/linking/objectTypes/memberType.xml index 66281317..15043335 100644 --- a/dmlex-v1.0/specification/modules/linking/objectTypes/memberType.xml +++ b/dmlex-v1.0/specification/modules/linking/objectTypes/memberType.xml @@ -23,18 +23,19 @@ Properties role - optional (zero or one) and unique (in combination with other unique properties if present). - String. + optional (zero or one) and unique (in + combination with other unique properties if present). Normalised string. description - optional (zero or one). Non-empty string. A human-readable + optional (zero or one). Normalised string. A human-readable explanation of this member role. type - required (exactly one) and unique (in combination with other unique properties if present). Non-empty string. A restriction on the types - of objects that can have this role. The possible values are: + required (exactly one) and unique (in + combination with other unique properties if present). Normalised string. A restriction on + the types of objects that can have this role. The possible values are: @@ -52,21 +53,21 @@ min - optional (zero or one). Number. Says that relations of this type must - have at least this many members with this role. If omitted then there is no lower limit - (effectively, zero). + optional (zero or one). Non-negative integer. Says that relations of + this type must have at least this many members with this role. If omitted then there is no + lower limit (effectively, zero). max - optional (zero or one). Number. Says that relations of this type may - have at most this many members with this role. If omitted then there is no upper - limit. + optional (zero or one). Non-negative integer. Says that relations of + this type may have at most this many members with this role. If omitted then there is no + upper limit. hint - optional (zero or one). Non-empty string. Suggests what machine - agents should do when showing this member to a human user (in the context of another member - of the same relation). The possible values are: + optional (zero or one). Suggests what machine agents should do when + showing this member to a human user (in the context of another member of the same relation). + The possible values are: diff --git a/dmlex-v1.0/specification/modules/linking/objectTypes/relation.xml b/dmlex-v1.0/specification/modules/linking/objectTypes/relation.xml index 9d804e46..2d1be20e 100644 --- a/dmlex-v1.0/specification/modules/linking/objectTypes/relation.xml +++ b/dmlex-v1.0/specification/modules/linking/objectTypes/relation.xml @@ -22,7 +22,7 @@ Properties type - required (exactly one). Non-empty string. Specifies what type of + required (exactly one). Normalised string. Specifies what type of relation it is, for example a relation between synonyms or a relation between a sense and a subsense. Optionally, relationType objects can be used to explain those types and to constrain @@ -30,7 +30,7 @@ description - optional (zero or one). Non-empty string. A human-readable + optional (zero or one). Normalised string. A human-readable explanation of this relation. diff --git a/dmlex-v1.0/specification/modules/linking/objectTypes/relationType.xml b/dmlex-v1.0/specification/modules/linking/objectTypes/relationType.xml index c3b4c9ac..463322a3 100644 --- a/dmlex-v1.0/specification/modules/linking/objectTypes/relationType.xml +++ b/dmlex-v1.0/specification/modules/linking/objectTypes/relationType.xml @@ -23,17 +23,18 @@ Properties type - required (exactly one) and unique. Non-empty string. + required (exactly one) and unique. Normalised + string. description - optional (zero or one). Non-empty string. A human-readable + optional (zero or one). Normalised string. A human-readable explanation of this relation type. scopeRestriction - optional (zero or one). Non-empty string. Specifies restrictions on - member of relations of this type. The possible values are: + optional (zero or one). Specifies restrictions on member of relations + of this type. The possible values are: diff --git a/dmlex-v1.0/specification/modules/values/objectTypes/definitionTypeTag.xml b/dmlex-v1.0/specification/modules/values/objectTypes/definitionTypeTag.xml index 3a1d19f6..ab90926d 100644 --- a/dmlex-v1.0/specification/modules/values/objectTypes/definitionTypeTag.xml +++ b/dmlex-v1.0/specification/modules/values/objectTypes/definitionTypeTag.xml @@ -26,13 +26,13 @@ Properties tag - required (exactly one) and unique. Non-empty string. An abbreviation, a code or - some other string of text. + required (exactly one) and unique. Normalised + string. An abbreviation, a code or some other string of text. description - optional (zero or one). Non-empty string. - A human-readable description of what the tag means. + optional (zero or one). Normalised string. A human-readable + description of what the tag means. sameAs diff --git a/dmlex-v1.0/specification/modules/values/objectTypes/inflectedFormTag.xml b/dmlex-v1.0/specification/modules/values/objectTypes/inflectedFormTag.xml index e901319b..05bbd2ec 100644 --- a/dmlex-v1.0/specification/modules/values/objectTypes/inflectedFormTag.xml +++ b/dmlex-v1.0/specification/modules/values/objectTypes/inflectedFormTag.xml @@ -27,18 +27,18 @@ Properties tag - required (exactly one) and unique. Non-empty string. An abbreviation, a code or - some other string of text. + required (exactly one) and unique. Normalised + string. An abbreviation, a code or some other string of text. description - optional (zero or one). Non-empty string. - A human-readable description of what the tag means. + optional (zero or one). Normalised string. A human-readable + description of what the tag means. for - optional (zero or one). Non-empty string. A statement about + optional (zero or one). Normalised string. A statement about constraints and recommendation on using this tag. This can be a human-readable description such as "for use with German nouns only" or a machine-readable instruction in any format understandable to the DMLex implemenation, such as partOfSpeech=noun AND diff --git a/dmlex-v1.0/specification/modules/values/objectTypes/labelTag.xml b/dmlex-v1.0/specification/modules/values/objectTypes/labelTag.xml index 48110a93..f0e900ec 100644 --- a/dmlex-v1.0/specification/modules/values/objectTypes/labelTag.xml +++ b/dmlex-v1.0/specification/modules/values/objectTypes/labelTag.xml @@ -26,28 +26,28 @@ Properties tag - required (exactly one) and unique. Non-empty string. An abbreviation, a code or - some other string of text. + required (exactly one) and unique. Normalised + string. An abbreviation, a code or some other string of text. description - optional (zero or one). Non-empty string. - A human-readable description of what the tag means. + optional (zero or one). Normalised string. A human-readable + description of what the tag means. typeTag - optional (zero or one). - Non-empty string. An abbreviation, a code or - some other string of text which identifies the type of the label, for example temporal for - temporal labels (archaic, neologism etc) or dialect for labels of dialects. The - labelTypeTag object type can be used to explain - the meaning of the type tags, to constrain which type tags are allowed to occur in the - lexicographic resource, and to map them onto external inventories and ontologies. + optional (zero or one). Normalised string. An abbreviation, a code or + some other string of text which identifies the type of the label, for example + temporal for temporal labels (archaic, neologism etc) or dialect + for labels of dialects. The labelTypeTag object type can be used to explain the meaning of the type + tags, to constrain which type tags are allowed to occur in the lexicographic resource, and + to map them onto external inventories and ontologies. for - optional (zero or one). Non-empty string. A statement about + optional (zero or one). Normalised string. A statement about constraints and recommendation on using this tag. This can be a human-readable description such as "for use with German nouns only" or a machine-readable instruction in any format understandable to the DMLex implemenation, such as partOfSpeech=noun AND diff --git a/dmlex-v1.0/specification/modules/values/objectTypes/labelTypeTag.xml b/dmlex-v1.0/specification/modules/values/objectTypes/labelTypeTag.xml index f2111906..75bd038d 100644 --- a/dmlex-v1.0/specification/modules/values/objectTypes/labelTypeTag.xml +++ b/dmlex-v1.0/specification/modules/values/objectTypes/labelTypeTag.xml @@ -26,13 +26,13 @@ Properties tag - required (exactly one) and unique. Non-empty string. An abbreviation, a code or - some other string of text. + required (exactly one) and unique. Normalised + string. An abbreviation, a code or some other string of text. description - optional (zero or one). Non-empty string. - A human-readable description of what the type tag means. + optional (zero or one). Normalised string. A human-readable + description of what the type tag means. sameAs diff --git a/dmlex-v1.0/specification/modules/values/objectTypes/partOfSpeechTag.xml b/dmlex-v1.0/specification/modules/values/objectTypes/partOfSpeechTag.xml index 15629db3..54b83221 100644 --- a/dmlex-v1.0/specification/modules/values/objectTypes/partOfSpeechTag.xml +++ b/dmlex-v1.0/specification/modules/values/objectTypes/partOfSpeechTag.xml @@ -27,20 +27,21 @@ Properties tag - required (exactly one) and unique. Non-empty string. An abbreviation, a code or - some other string of text. + required (exactly one) and unique. Normalised + string. An abbreviation, a code or some other string of text. description - optional (zero or one). Non-empty string. - A human-readable description of what the tag means. + optional (zero or one). Normalised string. A human-readable + description of what the tag means. for - optional (zero or one). Non-empty string. A statement about + optional (zero or one). Normalised string. A statement about constraints and recommendation on using this tag. This can be a human-readable description such as "for use in German and Czech only" or a machine-readable instruction in any format - understandable to the DMLex implemenation, such as language=de OR language=cs. + understandable to the DMLex implemenation, such as language=de OR + language=cs. sameAs diff --git a/dmlex-v1.0/specification/modules/values/objectTypes/sourceIdentityTag.xml b/dmlex-v1.0/specification/modules/values/objectTypes/sourceIdentityTag.xml index 0af178c1..7139071b 100644 --- a/dmlex-v1.0/specification/modules/values/objectTypes/sourceIdentityTag.xml +++ b/dmlex-v1.0/specification/modules/values/objectTypes/sourceIdentityTag.xml @@ -26,13 +26,13 @@ Properties tag - required (exactly one) and unique. Non-empty string. An abbreviation, a code or - some other string of text. + required (exactly one) and unique. Normalised + string. An abbreviation, a code or some other string of text. description - optional (zero or one). Non-empty string. - A human-readable description of what the tag means. + optional (zero or one). Normalised string. A human-readable + description of what the tag means. diff --git a/dmlex-v1.0/specification/modules/values/objectTypes/transcriptionSchemeTag.xml b/dmlex-v1.0/specification/modules/values/objectTypes/transcriptionSchemeTag.xml index 7ceed0eb..5b9cd9f6 100644 --- a/dmlex-v1.0/specification/modules/values/objectTypes/transcriptionSchemeTag.xml +++ b/dmlex-v1.0/specification/modules/values/objectTypes/transcriptionSchemeTag.xml @@ -30,15 +30,16 @@ description - optional (zero or one). Non-empty string. - A human-readable description of what the tag means. + optional (zero or one). Normalised string. A human-readable + description of what the tag means. for - optional (zero or one). Non-empty string. A statement about + optional (zero or one). Normalised string. A statement about constraints and recommendation on using this tag. This can be a human-readable description such as "for use in German and Czech only" or a machine-readable instruction in any format - understandable to the DMLex implemenation, such as language=de OR language=cs. + understandable to the DMLex implemenation, such as language=de OR + language=cs. diff --git a/dmlex-v1.0/specification/modules/xlingual/objectTypes/exampleTranslation.xml b/dmlex-v1.0/specification/modules/xlingual/objectTypes/exampleTranslation.xml index 1cf53913..34af93bc 100644 --- a/dmlex-v1.0/specification/modules/xlingual/objectTypes/exampleTranslation.xml +++ b/dmlex-v1.0/specification/modules/xlingual/objectTypes/exampleTranslation.xml @@ -23,7 +23,8 @@ Properties text - required (exactly one) and unique (in combination with langCode if present). Non-empty string. + required (exactly one) and unique (in + combination with langCode if present). Normalised string. langCode @@ -41,7 +42,7 @@ soundFile - optional (zero or one). A pointer to a file, such as a filename or a URI, containing a sound recording of the translation. + optional (zero or one). An Internationalized Resource Identifier (IRI) pointing to a file which contains a sound recording of the translation. listingOrder diff --git a/dmlex-v1.0/specification/modules/xlingual/objectTypes/headwordExplanation.xml b/dmlex-v1.0/specification/modules/xlingual/objectTypes/headwordExplanation.xml index c895237c..618c8e52 100644 --- a/dmlex-v1.0/specification/modules/xlingual/objectTypes/headwordExplanation.xml +++ b/dmlex-v1.0/specification/modules/xlingual/objectTypes/headwordExplanation.xml @@ -24,7 +24,8 @@ Properties text - required (exactly one) and unique (in combination with langCode if present). Non-empty string. + required (exactly one) and unique (in + combination with langCode if present). Normalised string. langCode @@ -50,7 +51,9 @@ XML -<headwordExplanation langCode="...">...</headwordExplanation> +<headwordExplanation langCode="..."> + <text>...</text> +</headwordExplanation> diff --git a/dmlex-v1.0/specification/modules/xlingual/objectTypes/headwordTranslation.xml b/dmlex-v1.0/specification/modules/xlingual/objectTypes/headwordTranslation.xml index 67a4d3c5..e05018db 100644 --- a/dmlex-v1.0/specification/modules/xlingual/objectTypes/headwordTranslation.xml +++ b/dmlex-v1.0/specification/modules/xlingual/objectTypes/headwordTranslation.xml @@ -24,7 +24,8 @@ Properties text - required (exactly one) and unique (in combination with langCode if present). Non-empty string. + required (exactly one) and unique (in + combination with langCode if present). Normalised string. langCode diff --git a/dmlex-v1.0/specification/serializations/XML/elements/definition.xml b/dmlex-v1.0/specification/serializations/XML/elements/definition.xml index 32da7cef..639c82df 100644 --- a/dmlex-v1.0/specification/serializations/XML/elements/definition.xml +++ b/dmlex-v1.0/specification/serializations/XML/elements/definition.xml @@ -15,16 +15,16 @@ @definitionType optional - - Text content + Child elements - Required, implements the text property. - If implementing the Annotation Module <definition> can - contain a mixture of plain text, <text> + required (exactly one). If implementing the Annotation Module + <text> can contain a mixture of plain text, + <headwordMarker> elements and <collocateMarker> - elements and whitespace inside it should be preserved. + elements. diff --git a/dmlex-v1.0/specification/serializations/XML/elements/entry.xml b/dmlex-v1.0/specification/serializations/XML/elements/entry.xml index 0bc41964..0dc13ca2 100644 --- a/dmlex-v1.0/specification/serializations/XML/elements/entry.xml +++ b/dmlex-v1.0/specification/serializations/XML/elements/entry.xml @@ -30,8 +30,7 @@ required (exactly one). If implementing the Annotation Module <headword> can contain a mixture of plain text and <placeholderMarker> elements and whitespace inside - it should be preserved. + ><placeholderMarker> elements. <partOfSpeech> optional (zero or more) diff --git a/dmlex-v1.0/specification/serializations/XML/elements/example.xml b/dmlex-v1.0/specification/serializations/XML/elements/example.xml index 6ab5f1b0..5463a534 100644 --- a/dmlex-v1.0/specification/serializations/XML/elements/example.xml +++ b/dmlex-v1.0/specification/serializations/XML/elements/example.xml @@ -31,7 +31,7 @@ <headwordMarker> elements and <collocateMarker> - elements and whitespace inside it should be preserved. + elements. <label> optional (zero or more) diff --git a/dmlex-v1.0/specification/serializations/XML/elements/exampleTranslation.xml b/dmlex-v1.0/specification/serializations/XML/elements/exampleTranslation.xml index 64121b87..708d30b5 100644 --- a/dmlex-v1.0/specification/serializations/XML/elements/exampleTranslation.xml +++ b/dmlex-v1.0/specification/serializations/XML/elements/exampleTranslation.xml @@ -31,7 +31,7 @@ <headwordMarker> elements and <collocateMarker> - elements and whitespace inside it should be preserved. + elements. <label> optional (zero or more) diff --git a/dmlex-v1.0/specification/serializations/XML/elements/headwordExplanation.xml b/dmlex-v1.0/specification/serializations/XML/elements/headwordExplanation.xml index c86eb3b4..2f6821cf 100644 --- a/dmlex-v1.0/specification/serializations/XML/elements/headwordExplanation.xml +++ b/dmlex-v1.0/specification/serializations/XML/elements/headwordExplanation.xml @@ -7,22 +7,23 @@ ]>
XML element: <literal><headwordExplanation></literal> - Implements the headwordExplanation object type from the Crosslingual Module. - + Implements the headwordExplanation + object type from the Crosslingual Module. Attributes - @langCode optional if the ancestor <lexicographicResource> - contains exactly one <translationLanguage>, - required otherwise + @langCode + optional if the ancestor + <lexicographicResource> contains exactly one + <translationLanguage>, required + otherwise - - Text content + Child elements - Required, implements the text property. + <text> + required (exactly one). -
diff --git a/dmlex-v1.0/specification/serializations/XML/elements/headwordTranslation.xml b/dmlex-v1.0/specification/serializations/XML/elements/headwordTranslation.xml index 10109333..7af35155 100644 --- a/dmlex-v1.0/specification/serializations/XML/elements/headwordTranslation.xml +++ b/dmlex-v1.0/specification/serializations/XML/elements/headwordTranslation.xml @@ -25,8 +25,7 @@ required (exactly one). If implementing the Annotation Module <text> can contain a mixture of plain text and <placeholderMarker> elements and whitespace inside - it should be preserved. + ><placeholderMarker> elements. <partOfSpeech> optional (zero or more) diff --git a/dmlex-v1.0/specification/serializations/XML/elements/transcription.xml b/dmlex-v1.0/specification/serializations/XML/elements/transcription.xml index 2db0ad15..c45fad36 100644 --- a/dmlex-v1.0/specification/serializations/XML/elements/transcription.xml +++ b/dmlex-v1.0/specification/serializations/XML/elements/transcription.xml @@ -7,20 +7,20 @@ ]>
XML element: <literal><transcription></literal> - Implements the transcription object type. - + Implements the transcription object + type. Attributes - @scheme optional + @scheme + optional - - Text content + Child elements - Required, implements the text property. + <text> + required (exactly one). -
diff --git a/dmlex-v1.0/specification/serializations/XML/specification.xml b/dmlex-v1.0/specification/serializations/XML/specification.xml index 6fd979b2..78ff0c33 100644 --- a/dmlex-v1.0/specification/serializations/XML/specification.xml +++ b/dmlex-v1.0/specification/serializations/XML/specification.xml @@ -25,37 +25,71 @@ The XML serialization of DMLex shown in this document follows these principles: - The top-level lexicographicResource object is implemented as an XML element. + The top-level lexicographicResource and entry object types + are implemented as XML elements. - All other objects are implemented as XML attributes of their parents, unless: + All other object types and their properties are implemented as XML attributes of their + parents, unless: - the object has an arity other than (0..1) and (1..1) - + the object has an arity other than (0..1) and (1..1) in + at least one of its parent objects or the object can have child objects - or the object's value is human-readable text, such as a headword or a definition. + or the object's value is human-readable text, such as a headword or a definition + (this applies, among other things, to all properties named text and + description). - In such cases the object is implemented as a child XML element of its parent. + In such cases the object or property is implemented as a child XML element of its parent. + + +
+ +
+ Whitespace handling + + Some XML elements in this serialization are defined as allowed to have text content + while other elements are not allowed to have text content. + + + + + Elements which are not allowed to have text content: + whitespace inside these elements should be treated as insignificant: + any child nodes consisting of whitespace can be ignored when reading the XML. + + + + + Elements which are allowed to have text content + (which includes elements implementing object types from the Annotation Module): + whitespace inside these elements should be handled as follows when reading the XML: + + + + Completely remove all leading whitespace that immediately follows an opening tag. + + + Completely remove all trailing whitespace that immediately precedes a closing tag. + + + Replace all remaining sequences of whitespace with a single space. + + + + This ensures that whitespace is handled in accordance with DMLex's concept of normalised strings + defined in . + - Whitespace in all text nodes should always be collapsed by rules - defined in the XML Schema W3C Recommendation [XML - Schema]: - - all sequences of whitespace should be reduced to a single space - - - all leading and trailing spaces should be removed - - unless otherwise stated in the specification of individual XML elements.
+
DMLex XML serialization elements