Skip to content

Commit

Permalink
Align with Datatype template improvements ("specialization of" sectio…
Browse files Browse the repository at this point in the history
…n added) (#3)
  • Loading branch information
chenejac committed Oct 10, 2023
1 parent 5ff09ae commit 1d5834f
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 14 deletions.
11 changes: 6 additions & 5 deletions datatypes/Postal_Address.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# Postal Address

The location assigned to an [Organisation Unit](../entities/Organisation_Unit.md) or some other CERIF entity instance.

## Components
## Definition

- country : [Country](../datatypes/Country.md)
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
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)
16 changes: 11 additions & 5 deletions datatypes/Simple_Postal_Address.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
# Simple Postal Address

## Definition

This data type is used when a string representation of postal address is used.

## Components

- address : [Multilingual String](../datatypes/Multilingual_String.md)
## 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.
This is a subtype of [Postal Address](../datatypes/Postal_Address.md), and therefore it also includes inherited country component.
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:

- address : [Multilingual String](../datatypes/Multilingual_String.md)

15 changes: 11 additions & 4 deletions datatypes/Structured_Postal_Address.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
# 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:

- street : [Multilingual String](../datatypes/Multilingual_String.md)
- city : [Multilingual String](../datatypes/Multilingual_String.md)
- ZIP code: [Multilingual String](../datatypes/Multilingual_String.md)
- stateOrProvince: [Multilingual String](../datatypes/Multilingual_String.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.
This is a subtype of [Postal Address](../datatypes/Postal_Address.md), and therefore it also includes inherited country component.

0 comments on commit 1d5834f

Please sign in to comment.