Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align the structure of datatype MD files #13

Open
chenejac opened this issue Oct 27, 2023 · 0 comments
Open

Align the structure of datatype MD files #13

chenejac opened this issue Oct 27, 2023 · 0 comments
Assignees

Comments

@chenejac
Copy link
Collaborator

For datatypes with components (xsd:complexType)

  1. Definition: The scope of the datatype and its meaning.
  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.
  5. Restrictions: An enumerated list of restrictions that apply between components (e.g. The start date and end date must have the same granularity)

  1. Matches: Describe any external datatypes this datatype matches.
  2. References: References to external resources in case these are referenced.

For datatypes without components (xsd:simpleType)

  1. Definition: The scope of the datatype and its meaning.
  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

  1. Matches: Describe any external datatypes this datatype matches.
  2. References: References to external resources in case these are referenced.
@chenejac chenejac self-assigned this Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant