From 0189e41f8784c04bfc73c8fbc0454f3e6a33932b Mon Sep 17 00:00:00 2001 From: Dragan Ivanovic Date: Fri, 27 Oct 2023 14:00:28 +0200 Subject: [PATCH] Align datatype MD files structure (#13) --- datatypes/Boolean.md | 1 + datatypes/Contact_Information.md | 2 -- datatypes/Country.md | 6 ++---- datatypes/DOI_ID.md | 10 ++++++---- datatypes/Date.md | 10 +++++----- datatypes/Date_Range.md | 11 ++++------- datatypes/Decimal.md | 2 +- datatypes/FundRef_ID.md | 10 ++++++---- datatypes/ISNI_ID.md | 10 +++++++--- datatypes/ISO_15924_Alpha4_Code.md | 10 +++++++--- datatypes/ISO_3166_Alpha2_Code.md | 10 +++++++--- datatypes/ISO_4217_Alpha_Code.md | 10 +++++++--- datatypes/ISO_639_1_Alpha2_Code.md | 10 +++++++--- datatypes/ISO_639_2B_Alpha3_Code.md | 10 +++++++--- datatypes/ISO_639_2T_Alpha3_Code.md | 10 +++++++--- datatypes/Language.md | 13 ++++--------- datatypes/Language_Tag.md | 8 +++++--- datatypes/Local_Agent_ID.md | 9 +++++---- datatypes/Monetary_Amount.md | 5 ++--- datatypes/Multilingual_String.md | 3 +-- datatypes/ORCID_iD.md | 12 ++++++++---- datatypes/Person_Name.md | 2 +- datatypes/Position.md | 3 +-- datatypes/Postal_Address.md | 3 --- datatypes/ROR_ID.md | 10 +++++++--- datatypes/Scopus_Author_ID.md | 10 +++++++--- datatypes/Script.md | 5 ++--- datatypes/Simple_Postal_Address.md | 12 ++++-------- datatypes/String.md | 1 + datatypes/Structured_Postal_Address.md | 12 ++++-------- datatypes/URI.md | 1 + datatypes/Wikidata_ID.md | 8 ++++++-- guidelines/DESCRIBING_DATATYPES.md | 10 ++++++---- guidelines/TEMPLATE_DATATYPE_COMPLEX.md | 2 ++ guidelines/TEMPLATE_DATATYPE_SIMPLE.md | 3 +++ 35 files changed, 144 insertions(+), 110 deletions(-) diff --git a/datatypes/Boolean.md b/datatypes/Boolean.md index 3d98867..df52f20 100644 --- a/datatypes/Boolean.md +++ b/datatypes/Boolean.md @@ -1,5 +1,6 @@ # Boolean +## Definition A boolean value, so either True or False. --- diff --git a/datatypes/Contact_Information.md b/datatypes/Contact_Information.md index 2e02596..985ed62 100644 --- a/datatypes/Contact_Information.md +++ b/datatypes/Contact_Information.md @@ -1,12 +1,10 @@ # Contact Information ## Definition - The contact information assigned to an [Agent](../entities/Organisation_Unit.md). The contact information might be Postal address, Visiting address, Email address, Telephone number, Website URL ## Components - - postalAddress : [Postal Address](../datatypes/Postal_Address.md) - visitingAddress : [Postal Address](../datatypes/Postal_Address.md) - phone : [String](../datatypes/String.md) diff --git a/datatypes/Country.md b/datatypes/Country.md index 5d7966b..414c424 100644 --- a/datatypes/Country.md +++ b/datatypes/Country.md @@ -4,12 +4,10 @@ An area of land that has or used to have its own government and laws.[1](#fn1) ## Components -ISO 3166 alpha2 code: [ISO 3166 Alpha2 Code Type](../datatypes/ISO_3166_Alpha2_Code.md) – this should be the preferred way of referencing a country - -name: [Multilingual String](../datatypes/Multilingual_String.md) +- ISO 3166 alpha2 code: [ISO 3166 Alpha2 Code Type](../datatypes/ISO_3166_Alpha2_Code.md) – this should be the preferred way of referencing a country +- name: [Multilingual String](../datatypes/Multilingual_String.md) --- - ## Matches 1. Close match of [Schema.org Country](https://schema.org/Country) diff --git a/datatypes/DOI_ID.md b/datatypes/DOI_ID.md index f9db59c..7052363 100644 --- a/datatypes/DOI_ID.md +++ b/datatypes/DOI_ID.md @@ -1,11 +1,13 @@ # The DOI (Digital Object Identifier) datatype +## Definition The datatype that represents the [Digital Object Identifiers](https://www.doi.org/). -It is based on the [String](../datatypes/String.md) datatype with the additional restriction that the string must match the following regular expression[1](#fn1): -``` -10\.[0-9]{4,}(\.[0-9]+)*/[^  ] -``` +## Based on +[String](../datatypes/String.md) + +## Restriction +1. The string must match the following regular expression[1](#fn1): `10\.[0-9]{4,}(\.[0-9]+)*/[^  ]` --- ## References diff --git a/datatypes/Date.md b/datatypes/Date.md index 6b9f8a4..2c6ef5a 100644 --- a/datatypes/Date.md +++ b/datatypes/Date.md @@ -1,13 +1,13 @@ # Date +## Definition Represents dates of the proleptic Gregorian calendar in line with the ISO 8601:2019 standard.[1](#fn1) -## Variants - +## Notes Three granularities are supported: -1. Full date (YYYY-MM-DD) -2. Year and month (YYYY-MM) -3. Just the year (YYYY) +- Full date (YYYY-MM-DD) +- Year and month (YYYY-MM) +- Just the year (YYYY) --- ## Matches diff --git a/datatypes/Date_Range.md b/datatypes/Date_Range.md index 88812d3..f6167a7 100644 --- a/datatypes/Date_Range.md +++ b/datatypes/Date_Range.md @@ -4,13 +4,10 @@ A range of [Dates](../datatypes/Date.md). ## Components -start date: [Date](../datatypes/Date.md) — optional; if missing, an indeterminate time in the past is implied - -start date inclusive: [Boolean](../datatypes/Boolean.md) — flags whether the *start date* belongs to the range or not - -end date: [Date](../datatypes/Date.md) — optional; if missing, "until present" is implied - -end date inclusive: [Boolean](../datatypes/Boolean.md) — flags whether the *end date* belongs to the range or not +- start date: [Date](../datatypes/Date.md) — optional; if missing, an indeterminate time in the past is implied +- start date inclusive: [Boolean](../datatypes/Boolean.md) — flags whether the *start date* belongs to the range or not +- end date: [Date](../datatypes/Date.md) — optional; if missing, "until present" is implied +- end date inclusive: [Boolean](../datatypes/Boolean.md) — flags whether the *end date* belongs to the range or not ## Constraints The *start date* and *end date* must have the same granularity. diff --git a/datatypes/Decimal.md b/datatypes/Decimal.md index 1b0b17b..87770f9 100644 --- a/datatypes/Decimal.md +++ b/datatypes/Decimal.md @@ -1,9 +1,9 @@ # Decimal +## Definition A rational number that can be expressed with a finite fractional part in the decimal system. ## Notes - Numbers can be positive, zero or negative. They include integers, but also non-integer numbers. A particular usage of this datatype may specify constraints on the range of admissible values or on the granularity (specified as the maximum number of decimal places). diff --git a/datatypes/FundRef_ID.md b/datatypes/FundRef_ID.md index 7437ffd..6858d53 100644 --- a/datatypes/FundRef_ID.md +++ b/datatypes/FundRef_ID.md @@ -1,11 +1,13 @@ # The FundRef ID datatype +## Definition The datatype that represents [Funder registry](https://www.crossref.org/services/funder-registry/) entries. -It is based on the [String](../datatypes/String.md) datatype with the additional restriction that the string must match the following regular expression[1](#fn1): -``` -[1-9]\d+ -``` +## Based on +[String](../datatypes/String.md) + +## Restrictions +1. The string must match the following regular expression[1](#fn1): `[1-9]\d+` --- ## References diff --git a/datatypes/ISNI_ID.md b/datatypes/ISNI_ID.md index 0ba8a19..19c6b17 100644 --- a/datatypes/ISNI_ID.md +++ b/datatypes/ISNI_ID.md @@ -1,10 +1,14 @@ # ISNI ID Type +## Definition The datatype that represents the [ISNI](https://isni.org/) identifier (International Standard Name Identifier). -It is based on the [String](../datatypes/String.md) datatype with the following restriction: -- the string must match the following regular expression: `https://isni\.org/isni/[0-9]{15}[0-9X]`[1](#fn1) -- the last character is the checksum character of the previous 15 digits (discarding the hyphens) calculated by the MOD11-2 algorithm[2](#fn2) +## Based on +[String](../datatypes/String.md) + +## Restrictions +1. The string must match the following regular expression[1](#fn1): `https://isni\.org/isni/[0-9]{15}[0-9X]` +1. The last character is the checksum character of the previous 15 digits (discarding the hyphens) calculated by the MOD11-2 algorithm[2](#fn2) --- ## References diff --git a/datatypes/ISO_15924_Alpha4_Code.md b/datatypes/ISO_15924_Alpha4_Code.md index e190f6a..3dd7819 100644 --- a/datatypes/ISO_15924_Alpha4_Code.md +++ b/datatypes/ISO_15924_Alpha4_Code.md @@ -1,10 +1,14 @@ # The ISO 15924 Four-letter Script Code datatype +## Definition The datatype that represents the four-letter codes of scripts in line with the ISO 15924 standard[1](#fn1). -It is based on the [String](../datatypes/String.md) datatype with the additional restrictions: -- the string must match the following regular expression `[A-Z][a-z]{3}` (one uppercase letter followed by three lower-case letters of the English alphabet) -- the combination of letters actually identifiers a script in the ISO 15924 standard +## Based on +[String](../datatypes/String.md) + +## Restrictions +1. The string must match the following regular expression `[A-Z][a-z]{3}` (one uppercase letter followed by three lower-case letters of the English alphabet) +1. The combination of letters actually identifiers a script in the ISO 15924 standard --- ## References diff --git a/datatypes/ISO_3166_Alpha2_Code.md b/datatypes/ISO_3166_Alpha2_Code.md index 86966fb..1773f7a 100644 --- a/datatypes/ISO_3166_Alpha2_Code.md +++ b/datatypes/ISO_3166_Alpha2_Code.md @@ -1,10 +1,14 @@ # The ISO 3166 Two-Letter Country Code datatype +## Definition The datatype that represents the two-letter codes of countries in line with the ISO 3166-1 Alpha-2 standard[1](#fn1). -It is based on the [String](../datatypes/String.md) datatype with the following additional restrictions: -- the string must match the following regular expression: `[A-Z]{2}` (two uppercase letters of the English alphabet) -- the combination of letters must actually identify a country in the ISO 3166 standard +## Based on +[String](../datatypes/String.md) + +## Restrictions +1. The string must match the following regular expression: `[A-Z]{2}` (two uppercase letters of the English alphabet) +1. The combination of letters must actually identify a country in the ISO 3166 standard --- ## References diff --git a/datatypes/ISO_4217_Alpha_Code.md b/datatypes/ISO_4217_Alpha_Code.md index a7c5b5d..007074b 100644 --- a/datatypes/ISO_4217_Alpha_Code.md +++ b/datatypes/ISO_4217_Alpha_Code.md @@ -1,10 +1,14 @@ # The ISO 4217 Three-Letter Currency Code datatype +## Definition The datatype that represents the three-letter codes of currencies in line with the ISO 4217 standard[1](#fn1). -It is based on the [String](../datatypes/String.md) datatype with the following additional restrictions: -- the string must match the following regular expression: `[A-Z]{3}` (three uppercase letters of the English alphabet) -- the combination of letters must actually identify a currency in the ISO 4217 standard +## Based on +[String](../datatypes/String.md) + +## Restrictions +1. The string must match the following regular expression: `[A-Z]{3}` (three uppercase letters of the English alphabet) +1. The combination of letters must actually identify a currency in the ISO 4217 standard --- ## References diff --git a/datatypes/ISO_639_1_Alpha2_Code.md b/datatypes/ISO_639_1_Alpha2_Code.md index 5c1eef1..e9b8fbc 100644 --- a/datatypes/ISO_639_1_Alpha2_Code.md +++ b/datatypes/ISO_639_1_Alpha2_Code.md @@ -1,10 +1,14 @@ # The ISO 639-1 alpha-2 Language Code datatype +## Definition The datatype that represents the two-letter codes of languages in line with the ISO 639-1 standard[1](#fn1). -It is based on the [String](../datatypes/String.md) datatype with the following additional restrictions: -- the string must match the following regular expression `[a-z]{2}` (two lower-case letters of the English alphabet) -- the combination of letters actually identifiers a language in the ISO 639-1 standard +## Based on +[String](../datatypes/String.md) + +## Restrictions +1. The string must match the following regular expression `[a-z]{2}` (two lower-case letters of the English alphabet) +1. The combination of letters actually identifiers a language in the ISO 639-1 standard --- ## References diff --git a/datatypes/ISO_639_2B_Alpha3_Code.md b/datatypes/ISO_639_2B_Alpha3_Code.md index 74d2373..994c68c 100644 --- a/datatypes/ISO_639_2B_Alpha3_Code.md +++ b/datatypes/ISO_639_2B_Alpha3_Code.md @@ -1,10 +1,14 @@ # The ISO 639-2 alpha-3 Bibliographic Language Code datatype +## Definition The datatype that represents the three-letter bibliographic codes of languages in line with the ISO 639-2B standard[1](#fn1). -It is based on the [String](../datatypes/String.md) datatype with the additional restrictions: -- the string must match the following regular expression `[a-z]{3}` (three lower-case letters of the English alphabet) -- the combination of letters actually identifiers a language in the ISO 639-2B standard +## Based on +[String](../datatypes/String.md) + +## Restrictions +1. The string must match the following regular expression `[a-z]{3}` (three lower-case letters of the English alphabet) +1. The combination of letters actually identifiers a language in the ISO 639-2B standard --- ## References diff --git a/datatypes/ISO_639_2T_Alpha3_Code.md b/datatypes/ISO_639_2T_Alpha3_Code.md index d0409b1..c747d74 100644 --- a/datatypes/ISO_639_2T_Alpha3_Code.md +++ b/datatypes/ISO_639_2T_Alpha3_Code.md @@ -1,10 +1,14 @@ # The ISO 639-2 alpha-3 Terminology Language Code datatype +## Definition The datatype that represents the three-letter terminology codes of languages in line with the ISO 639-2T standard[1](#fn1). -It is based on the [String](../datatypes/String.md) datatype with the additional restrictions: -- the string must match the following regular expression `[a-z]{3}` (three lower-case letters of the English alphabet) -- the combination of letters actually identifiers a language in the ISO 639-2T standard +## Based on +[String](../datatypes/String.md) + +## Restrictions +1. The string must match the following regular expression `[a-z]{3}` (three lower-case letters of the English alphabet) +1. The combination of letters actually identifiers a language in the ISO 639-2T standard --- ## References diff --git a/datatypes/Language.md b/datatypes/Language.md index 9d83c25..22e8ddf 100644 --- a/datatypes/Language.md +++ b/datatypes/Language.md @@ -4,20 +4,15 @@ A system of communication used by people living in a particular country consisting of sounds, words, and grammar.[1](#fn1) ## Notes - Lists of languages are complied as controlled vocabularies.[2](#fn2) ## Components -name: [Multilingual String](../datatypes/Multilingual_String.md) - -ISO639 1 code: [ISO639 1 Alpha2 Code Type](../datatypes/ISO_639_1_Alpha2_Code.md) - -ISO639 2T code: [ISO639 2T Alpha3 Code Type](../datatypes/ISO_639_2T_Alpha3_Code.md) - -ISO639 2B code: [ISO639 2B Alpha3 Code Type](../datatypes/ISO_639_2B_Alpha3_Code.md) +- name: [Multilingual String](../datatypes/Multilingual_String.md) +- ISO639 1 code: [ISO639 1 Alpha2 Code Type](../datatypes/ISO_639_1_Alpha2_Code.md) +- ISO639 2T code: [ISO639 2T Alpha3 Code Type](../datatypes/ISO_639_2T_Alpha3_Code.md) +- ISO639 2B code: [ISO639 2B Alpha3 Code Type](../datatypes/ISO_639_2B_Alpha3_Code.md) --- - ## Matches 1. Close match of [Schema.org Language](https://schema.org/Language) diff --git a/datatypes/Language_Tag.md b/datatypes/Language_Tag.md index f236f3e..473c435 100644 --- a/datatypes/Language_Tag.md +++ b/datatypes/Language_Tag.md @@ -8,12 +8,14 @@ The syntax and semantics of language tags is specified by the BCP 47 standard[1](#fn1) ## Components -amount: [Decimal](../datatypes/Decimal.md) – mandatory - -currency code: [ISO 4217 Alpha Code](../datatypes/ISO_4217_Alpha_Code.md) – mandatory +- amount: [Decimal](../datatypes/Decimal.md) – mandatory +- currency code: [ISO 4217 Alpha Code](../datatypes/ISO_4217_Alpha_Code.md) – mandatory --- diff --git a/datatypes/Multilingual_String.md b/datatypes/Multilingual_String.md index 5b7f947..c962067 100644 --- a/datatypes/Multilingual_String.md +++ b/datatypes/Multilingual_String.md @@ -1,12 +1,11 @@ # Multilinqual String +## Definition One or several [Strings](../datatypes/String.md) optionally qualified by distinct [Language Tags](../datatypes/Language_Tag.md). --- ## Matches - This datatype matches the `rdf:PlainLiteral`[1](#fn1). ## References - \[1\] Bao, J. et al.: *rdf:PlainLiteral: A Datatype for RDF Plain Literals (Second Edition)*. W3C Recommendation 11 December 2012, https://www.w3.org/TR/rdf-plain-literal/ diff --git a/datatypes/ORCID_iD.md b/datatypes/ORCID_iD.md index e138fa4..9ced72c 100644 --- a/datatypes/ORCID_iD.md +++ b/datatypes/ORCID_iD.md @@ -1,12 +1,16 @@ # ORCID iD Type -The datatype that represents the [ORCID identifier](../entities/ORCID_Identifier.md). +## Definition +The datatype that represents the [ORCID](https://orcid.org/) identifier. -It is based on the [String](../datatypes/String.md) datatype with the following restriction: -- the string must match one of the following regular expressions:[1](#fn1) +## Based on +[String](../datatypes/String.md) + +## Restrictions +1. The string must match one of the following regular expressions:[1](#fn1) - `https://orcid\.org/0000-000((1-[5-9]|2-[0-9]|3-[0-4])[0-9]{3}-[0-9]{3}[0-9X]|3-5000-0001)` - `https://orcid\.org/0009-00(0[0-9]-[0-9]{4}-[0-9]{3}[0-9X]|10-0000-0000)` -- the last character is the checksum character of the previous 15 digits (discarding the hyphens) calculated by the MOD11-2 algorithm[2](#fn2) +1. The last character is the checksum character of the previous 15 digits (discarding the hyphens) calculated by the MOD11-2 algorithm[2](#fn2) --- ## References diff --git a/datatypes/Person_Name.md b/datatypes/Person_Name.md index 80c3835..bd35ce7 100644 --- a/datatypes/Person_Name.md +++ b/datatypes/Person_Name.md @@ -1,9 +1,9 @@ # Person Name +## Definition The name of a [Person](../entities/Person.md). ## Components - - first names : [Multilingual String](../datatypes/Multilingual_String.md) - family names : [Multilingual String](../datatypes/Multilingual_String.md) - other names : [Multilingual String](../datatypes/Multilingual_String.md) diff --git a/datatypes/Position.md b/datatypes/Position.md index a1f1b40..b3538ad 100644 --- a/datatypes/Position.md +++ b/datatypes/Position.md @@ -11,8 +11,7 @@ data type can be found in the relation between [Postal Address](../datatypes/Pos [Structured Postal Address](../datatypes/Structured_Postal_Address.md) ## Components - -title : [Multilingual String](../datatypes/Multilingual_String.md) +- title : [Multilingual String](../datatypes/Multilingual_String.md) --- ## Matches diff --git a/datatypes/Postal_Address.md b/datatypes/Postal_Address.md index 1cb11cd..2146465 100644 --- a/datatypes/Postal_Address.md +++ b/datatypes/Postal_Address.md @@ -1,14 +1,11 @@ # Postal Address ## Definition - The location assigned to an [Organisation Unit](../entities/Organisation_Unit.md) or some other CERIF entity instance. ## Notes - Please note there are two specializations of this data type providing more or less structured details about a postal address [Simple Postal Address](../datatypes/Simple_Postal_Address.md) and [Structured Postal Address](../datatypes/Structured_Postal_Address.md) ## Components - - country : [Country](../datatypes/Country.md) diff --git a/datatypes/ROR_ID.md b/datatypes/ROR_ID.md index 00143ae..e7442d9 100644 --- a/datatypes/ROR_ID.md +++ b/datatypes/ROR_ID.md @@ -1,10 +1,14 @@ # ROR ID Type +## Definition The datatype that represents the [ROR](https://ror.org/) identifier. -It is based on the [String](../datatypes/String.md) datatype with the following restrictions:[1](#fn1) -- the string must match the regular expression: `https://ror\.org/0[0-9a-hjkmnp-tv-z]{6}(0[2-9]|[1-8][0-9]|9[0-8])` -- the last two digits are the modulo 97-10 checksum[2](#fn2) of the number formed by the preceding six digits +## Based on +[String](../datatypes/String.md) + +## Restrictions +1. The string must match the regular expression[1](#fn1): `https://ror\.org/0[0-9a-hjkmnp-tv-z]{6}(0[2-9]|[1-8][0-9]|9[0-8])` +1. The last two digits are the modulo 97-10 checksum[2](#fn2) of the number formed by the preceding six digits --- ## References diff --git a/datatypes/Scopus_Author_ID.md b/datatypes/Scopus_Author_ID.md index 3a1d180..affb702 100644 --- a/datatypes/Scopus_Author_ID.md +++ b/datatypes/Scopus_Author_ID.md @@ -1,8 +1,12 @@ # Scopus Author ID Type -The datatype that represents the [Scopus Author identifier](../entities/Scopus_Author_Identifier.md). +## Definition +The datatype that represents the [Scopus Author](https://scopus.com) identifier. -It is based on the [Decimal](../datatypes/Decimal.md) datatype with the following restriction: -- it is a positive integer usually with 10 or 11 digits +## Based on +[Decimal](../datatypes/Decimal.md) + +## Restrictions +1. A positive integer with 10 or 11 digits diff --git a/datatypes/Script.md b/datatypes/Script.md index 981e0d8..ee5def5 100644 --- a/datatypes/Script.md +++ b/datatypes/Script.md @@ -8,9 +8,8 @@ An example of different scripts for the same language might be Cyrillic and Lati ISO 15924 standardizes[2](#fn2) the codes for scripts. ## Components -name: [Multilingual String](../datatypes/Multilingual_String.md) - -script code: [ISO 15924 Alphabetic Code Type](../datatypes/ISO_15924_Alpha4_Code.md) +- name: [Multilingual String](../datatypes/Multilingual_String.md) +- script code: [ISO 15924 Alphabetic Code Type](../datatypes/ISO_15924_Alpha4_Code.md) --- ## References diff --git a/datatypes/Simple_Postal_Address.md b/datatypes/Simple_Postal_Address.md index d96537e..4ff1296 100644 --- a/datatypes/Simple_Postal_Address.md +++ b/datatypes/Simple_Postal_Address.md @@ -1,19 +1,15 @@ # Simple Postal Address ## Definition - This data type is used when a string representation of postal address is used. -## Specialization of -[Postal Address](../datatypes/Postal_Address.md) - ## Notes - The main intended usage of multiple strings for different languages is to allow the representation of the addresses in different scripts, allowing for transliterations. -## Components - -Beside those inherited from [Postal Address](../datatypes/Postal_Address.md#components), there are also the following components: +## Specialization of +[Postal Address](../datatypes/Postal_Address.md) +## Components +- those inherited from [Postal Address](../datatypes/Postal_Address.md#components) - address : [Multilingual String](../datatypes/Multilingual_String.md) diff --git a/datatypes/String.md b/datatypes/String.md index 8a056ab..bbb3d0a 100644 --- a/datatypes/String.md +++ b/datatypes/String.md @@ -1,5 +1,6 @@ # String +## Definition A string of Unicode characters of any length. --- diff --git a/datatypes/Structured_Postal_Address.md b/datatypes/Structured_Postal_Address.md index f0e938c..e950def 100644 --- a/datatypes/Structured_Postal_Address.md +++ b/datatypes/Structured_Postal_Address.md @@ -1,20 +1,16 @@ # Structured Postal Address ## Definition - This data type is used when a structured representation of postal address is used. -## Specialization of -[Postal Address](../datatypes/Postal_Address.md) - ## Notes - The main intended usage of multiple strings for different languages is to allow the representation of the addresses in different scripts, allowing for transliterations. -## Components - -Beside those inherited from [Postal Address](../datatypes/Postal_Address.md#components), there are also the following components: +## Specialization of +[Postal Address](../datatypes/Postal_Address.md) +## Components +- those inherited from [Postal Address](../datatypes/Postal_Address.md#components) - street : [Multilingual String](../datatypes/Multilingual_String.md) - city : [Multilingual String](../datatypes/Multilingual_String.md) - ZIP code: [Multilingual String](../datatypes/Multilingual_String.md) diff --git a/datatypes/URI.md b/datatypes/URI.md index a6915b0..93afd2d 100644 --- a/datatypes/URI.md +++ b/datatypes/URI.md @@ -1,5 +1,6 @@ # URI (Uniform Resource Identifier) +## Definition Any sequence of characters that is legal as a Uniform Resource Identifier[1](#fn1). Relative URIs are supported too, but the datatype does not specify their resolution context. diff --git a/datatypes/Wikidata_ID.md b/datatypes/Wikidata_ID.md index 6e50f0a..36b0f8e 100644 --- a/datatypes/Wikidata_ID.md +++ b/datatypes/Wikidata_ID.md @@ -1,9 +1,13 @@ # Wikidata item URL Type +## Definition The datatype that represents the URL of the agent as an item in [Wikidata](https://www.wikidata.org/). -It is based on the [String](../datatypes/String.md) datatype with the following restriction:[1](#fn1) -- the string must match the regular expression: `https://www\.wikidata\.org/wiki/Q[0-9]+` +## Based on +[String](../datatypes/String.md) + +## Restrictions +1. The string must match the regular expression[1](#fn1): `https://www\.wikidata\.org/wiki/Q[0-9]+` --- ## References diff --git a/guidelines/DESCRIBING_DATATYPES.md b/guidelines/DESCRIBING_DATATYPES.md index 944b3da..3c8e1bf 100644 --- a/guidelines/DESCRIBING_DATATYPES.md +++ b/guidelines/DESCRIBING_DATATYPES.md @@ -16,9 +16,10 @@ A heading is left out if the section is empty. 2. **Notes**: An additional description to communicate the purpose of the datatype. 3. **Specialization of**: The link to the super datatype (the datatype this type extends) 4. **Components**: The list of fields the datatype is composed of. Similar to attributes for [entities](DESCRIBING_ENTITIES.md#sections). +5. **Restrictions**: An enumerated list of restrictions that apply between components (e.g. The *start date* and *end date* must have the same granularity) --- -5. **Matches**: Describe any external datatypes this datatype matches. -6. **References**: References to external resources in case these are referenced. +6. **Matches**: Describe any external datatypes this datatype matches. +7. **References**: References to external resources in case these are referenced. Use the [template file](./TEMPLATE_DATATYPE_COMPLEX.md) as a starting point. @@ -27,8 +28,9 @@ Use the [template file](./TEMPLATE_DATATYPE_COMPLEX.md) as a starting point. 2. **Notes**: An additional description to communicate the purpose of the datatype. 3. **Based on**: The link to the base datatype (the datatype this type restricts) 4. **Restrictions**: An enumerated list of restrictions that apply (e.g. maximum length, regular expression, possibly also algorithmic restrictions such as checksums) +5. **Examples**: A list of examples --- -5. **Matches**: Describe any external datatypes this datatype matches. -6. **References**: References to external resources in case these are referenced. +6. **Matches**: Describe any external datatypes this datatype matches. +7. **References**: References to external resources in case these are referenced. Use the [template file](./TEMPLATE_DATATYPE_SIMPLE.md) as a starting point. \ No newline at end of file diff --git a/guidelines/TEMPLATE_DATATYPE_COMPLEX.md b/guidelines/TEMPLATE_DATATYPE_COMPLEX.md index e70dfba..e244d3a 100644 --- a/guidelines/TEMPLATE_DATATYPE_COMPLEX.md +++ b/guidelines/TEMPLATE_DATATYPE_COMPLEX.md @@ -16,6 +16,8 @@ An additional description to communicate the purpose of the datatype. The list of fields the datatype is composed of. Similar to attributes for [entities](./DESCRIBING_ENTITIES.md#sections). +## Restrictions +1. ... --- ## Matches 1. Close match of [whatever](url) diff --git a/guidelines/TEMPLATE_DATATYPE_SIMPLE.md b/guidelines/TEMPLATE_DATATYPE_SIMPLE.md index 50d9a1b..61bfb74 100644 --- a/guidelines/TEMPLATE_DATATYPE_SIMPLE.md +++ b/guidelines/TEMPLATE_DATATYPE_SIMPLE.md @@ -15,6 +15,9 @@ An additional description to communicate the purpose of the datatype. ## Restrictions 1. ... +## Examples +- ... + --- ## Matches 1. Close match of [whatever](url)