Align datatype MD files structure (#13)

EuroCRIS · Oct 27, 2023 · 0189e41 · 0189e41
1 parent 4b42776
commit 0189e41
Show file tree

Hide file tree

Showing 35 changed files with 144 additions and 110 deletions.
diff --git 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
@@ -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
@@ -4,12 +4,10 @@
 An area of land that has or used to have its own government and laws.<sup>[1](#fn1)</sup>
 
 ## 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
@@ -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<sup>[1](#fn1)</sup>:
-```
-10\.[0-9]{4,}(\.[0-9]+)*/[^  ]
-```
+## Based on
+[String](../datatypes/String.md) 
+
+## Restriction
+1. The string must match the following regular expression<sup>[1](#fn1)</sup>: `10\.[0-9]{4,}(\.[0-9]+)*/[^  ]`
 
 ---
 ## References

diff --git 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.<sup>[1](#fn1)</sup>
 
-## 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
@@ -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
@@ -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
@@ -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<sup>[1](#fn1)</sup>:
-```
-[1-9]\d+
-```
+## Based on
+[String](../datatypes/String.md) 
+
+## Restrictions
+1. The string must match the following regular expression<sup>[1](#fn1)</sup>: `[1-9]\d+`
 
 ---
 ## References

diff --git 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]`<sup>[1](#fn1)</sup>
-- the last character is the checksum character of the previous 15 digits (discarding the hyphens) calculated by the MOD11-2 algorithm<sup>[2](#fn2)</sup>
+## Based on
+[String](../datatypes/String.md)
+
+## Restrictions
+1. The string must match the following regular expression<sup>[1](#fn1)</sup>: `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<sup>[2](#fn2)</sup>
 
 ---
 ## References

diff --git 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<sup>[1](#fn1)</sup>.
 
-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
@@ -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<sup>[1](#fn1)</sup>.
 
-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
@@ -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<sup>[1](#fn1)</sup>.
 
-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
@@ -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<sup>[1](#fn1)</sup>.
 
-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
@@ -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<sup>[1](#fn1)</sup>.
 
-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
@@ -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<sup>[1](#fn1)</sup>.
 
-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
@@ -4,20 +4,15 @@
 A system of communication used by people living in a particular country consisting of sounds, words, and grammar.<sup>[1](#fn1)</sup>
 
 ## Notes
-
 Lists of languages are complied as controlled vocabularies.<sup>[2](#fn2)</sup>
 
 ## 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
@@ -8,12 +8,14 @@ The syntax and semantics of language tags is specified by the BCP 47 standard<su
 
 Language tags are used as language qualifiers in [Multilingual Strings](../datatypes/Multilingual_String.md).
 
-## Syntax
+## Based on
+[String](../datatypes/String.md)
 
-A code for [language](../datatypes/Language.md), optionally followied by codes 
+## Restrictions
+1. A code for [language](../datatypes/Language.md), optionally followied by codes 
 for a [script](../datatypes/Script.md), a [country](../datatypes/Country.md) or for other aspects, separated by dashes (`-`).
 
-Examples:
+## Examples
 - `en` - English
 - `de-AT` - German as used in Austria
 - `sr-Cyrl` - Serbian written in Cyrillic 

diff --git a/datatypes/Local_Agent_ID.md b/datatypes/Local_Agent_ID.md
@@ -1,13 +1,14 @@
 # Local Agent ID Type
 
 ## Definition
-
-The datatype that represents a local identifier. It is based on the [String](../datatypes/String.md) without any restriction.
+The datatype that represents a local identifier. 
 
 ## Notes
-
 If some restriction is needed for a specific local identifier, Local Agent ID Type should be specialized by defining regular expression
 or any other restriction over String. An example of defining restriction over String can be found in the definition of [ISNI ID](../datatypes/ISNI_ID.md).  
-An example of defining specification of a data type can be found in the relation between [Postal Address](../datatypes/Postal_Address.md) and 
+An example of defining specification of a data type can be found in the relation between [Postal Address](../datatypes/Postal_Address.md) and
 [Structured Postal Address](../datatypes/Structured_Postal_Address.md)
 
+## Based on 
+[String](../datatypes/String.md)
+
diff --git a/datatypes/Monetary_Amount.md b/datatypes/Monetary_Amount.md
@@ -7,9 +7,8 @@ A certain volume of money, together with the specification of a currency.
 Currency: The money that is used in a particular country at a particular time.<sup>[1](#fn1)</sup>
 
 ## 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
@@ -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`<sup>[1](#fn1)</sup>.
 
 ## References
-
 <a name="fn1">\[1\]</a> 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
@@ -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:<sup>[1](#fn1)</sup> 
+## Based on 
+[String](../datatypes/String.md) 
+
+## Restrictions
+1. The string must match one of the following regular expressions:<sup>[1](#fn1)</sup> 
   - `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<sup>[2](#fn2)</sup>
+1. The last character is the checksum character of the previous 15 digits (discarding the hyphens) calculated by the MOD11-2 algorithm<sup>[2](#fn2)</sup>
 
 ---
 ## References

diff --git 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
@@ -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
@@ -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)