README.md 6.18 KB
Newer Older
mrodzis's avatar
mrodzis committed
1
# LIDO version 1.1
p.mklindt's avatar
p.mklindt committed
2

mrodzis's avatar
mrodzis committed
3
4
5
6
## What's new in LIDO v1.1

### General

mrodzis's avatar
mrodzis committed
7
The schema is developed at <https://gitlab.gwdg.de/lido/development>. The most recent draft version can be found at <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1.xsd>.
mrodzis's avatar
mrodzis committed
8
9
10

For the development of LIDO v1.1 the following criteria for taking into account suggestions for changes and extensions have been defined:

mrodzis's avatar
mrodzis committed
11
12
13
14
- The suggestion requires modification of the schema, e.g. there is no way to express the information in the LIDO v1.0 schema.
- The suggestion is based upon a known use case from practical LIDO applications.
- The requirement is generic and in the scope of LIDO v1.0.
- The suggestion can be implemented in a backwards compatible way with LIDO v1.0.
mrodzis's avatar
mrodzis committed
15
16
17

### General changes

mrodzis's avatar
mrodzis committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
#### Documentation

The schema docs are provided in a structured way as TEI elements as follows:

- the element description
- the element's label
- elements from other schemas to which the respective LIDO element is equivalent
- a note where a user can find more context about the element (this often refers to CDWA FULL, as LIDO elements are largely based on LIDO's predecessor CDWA Lite)
- recommended data values for controlled terms
- the following docs have been removed: 'How to record', 'Notes' (both outdated and largely merged into the element description)

Furthermore, the following additions have been made:

- machine-readable metadata is provided in a TEI header.
- each LIDO element/complexType/attribute is now referenceable by an ID. This ID is (in most cases) identical to its name and comes in handy for developing application profiles.

#### Accompanying Documents

Apart from the documentation elements there are accompanying documents providing further information on LIDO elements:
mrodzis's avatar
mrodzis committed
37

mrodzis's avatar
mrodzis committed
38
39
- a **metadata crosswalk** provides a mapping of LIDOv1.1 elements to LIDOv1.0, CDWA Lite, museumdat, and Spectrum. CIDOC-CRM equivalents are provided in `metadata-crosswalk.xml`, but are not serialized because they are not complete yet.
- **links for further information** and **terminology recommendations**
mrodzis's avatar
mrodzis committed
40

mrodzis's avatar
mrodzis committed
41
#### Schematron
mrodzis's avatar
mrodzis committed
42

mrodzis's avatar
mrodzis committed
43
We introduced Schematron as a second quality assurance mechanism. This is e.g. used to ensure that dates comply to the xs:dateTime requirements.
mrodzis's avatar
mrodzis committed
44

mrodzis's avatar
mrodzis committed
45
While there are Schematron rules in the schema itself which we consider as essential for data quality, more quality assuring rules can be found in `lido-qa.xsd`. If you want these included in the validation, choose the schema `lidov.1.1.xsd`. If you do not want these to be included in the validation, choose the schema `lidov1.1-unrestricted.xsd`.
mrodzis's avatar
mrodzis committed
46

mrodzis's avatar
mrodzis committed
47
### New Elements (and Why They Have Been Introduced)
mrodzis's avatar
mrodzis committed
48

mrodzis's avatar
mrodzis committed
49
- **applicationProfile**: Serves as an identifier for a LIDO application profile which has been developed by an institution or project.
mrodzis's avatar
mrodzis committed
50

mrodzis's avatar
mrodzis committed
51
- **conceptElementsSet**: Increases the schema's modularity.
mrodzis's avatar
mrodzis committed
52

mrodzis's avatar
mrodzis committed
53
- **displayRelatedWork**: A display element displayRelatedWork for the relatedWorkSet allows for transferring specific relationship information for presentation purposes while for the actual relationship type element (lido:relatedWorkRelType) terms from the LIDO Terminology should be used.
mrodzis's avatar
mrodzis committed
54

mrodzis's avatar
mrodzis committed
55
- **displayRepository**: A free-text description for designation of the institution of custody and, possibly, a descriptive indication of the exact location of the object while for repositoryName and repositoryLocation authorities should be used.
mrodzis's avatar
mrodzis committed
56

mrodzis's avatar
mrodzis committed
57
- **eventObjectMeasurements**: Indicates the dimensions or other measurements of the object/work as determined with respect to the described event, for instance a part addition or removal.
mrodzis's avatar
mrodzis committed
58

mrodzis's avatar
mrodzis committed
59
- **objectDescriptionRights**: Allows for setting separate rights information for the object description.
mrodzis's avatar
mrodzis committed
60

mrodzis's avatar
mrodzis committed
61
- **objectMaterialsTechSet/objectMaterialsTechWrap**: Allows for materials/technique information (meant like a physical characteristic of the object) outside of events.
mrodzis's avatar
mrodzis committed
62

mrodzis's avatar
mrodzis committed
63
- **sourceActorInRole**: Allows for providing source information about an actor in a certain role.
mrodzis's avatar
mrodzis committed
64

mrodzis's avatar
mrodzis committed
65
- **sourceRelatedWorkSet**: Allows for providing source information about a related work.
mrodzis's avatar
mrodzis committed
66

mrodzis's avatar
mrodzis committed
67
- **sourceRepositorySet**: Allows for providing source information about a current or former repository.
mrodzis's avatar
mrodzis committed
68

mrodzis's avatar
mrodzis committed
69
- **textAttributesSet**: Increases the schema's modularity.
mrodzis's avatar
mrodzis committed
70

mrodzis's avatar
mrodzis committed
71
- **vitalPlaceActor**: Allows for providing the birth/death/activity place of an actor.
mrodzis's avatar
mrodzis committed
72

mrodzis's avatar
mrodzis committed
73
### New Attributes (and Why They Have Been Introduced)
mrodzis's avatar
mrodzis committed
74

mrodzis's avatar
mrodzis committed
75
76
77
78
79
80
81
82
83
84
85
- **measurementsGroup**: Indicates the group of measurements given in multiple LIDO Measurement Set elements. Of relevance for the EODEM application profile.

- **mostNotableEvent**: Qualifies an eventSet as the most notable or significant event as designated by the describing institution.

### New Complex Types (and Why They Have Been Introduced)

- **conceptMixedComplexType**: A complexType allowing both free text and the elements defined in conceptElementsSet. This complexType is used for elements that only allowed free text in LIDO v1.0 but should be controllable with conceptID(s) and term(s) in LIDO v1.1.

- **rightsHolderComplexType**: Increases the schema's modularity. rightsHolder doesn't have to be defined fully twice.

### Changed Content Model: Mixed Content
mrodzis's avatar
mrodzis committed
86
87
88

The following elements can contain free text only in LIDO v.1.0, but can also provide controlled terms (e.g. from authoritative data) as an alternative via conceptComplexType in LIDO v1.1:

mrodzis's avatar
mrodzis committed
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
- attributionQualifierActor
- extentActor
- extentMaterialsTech
- extentMeasurements
- extentSubject
- formatMeasurements
- genderActor
- measurementType
- measurementUnit
- qualifierMeasurements
- scaleMeasurements
- shapeMeasurements

### Changed Descriptions

Definitions have generally been renamed to 'description'.
Almost all descriptions have been revised and specified for clarity.
mrodzis's avatar
mrodzis committed
106

mrodzis's avatar
mrodzis committed
107
### Other Changes
mrodzis's avatar
mrodzis committed
108

mrodzis's avatar
mrodzis committed
109
The following elements can  now hold additional attributes:
mrodzis's avatar
mrodzis committed
110

mrodzis's avatar
mrodzis committed
111
112
113
114
115
- genderActor allows for lido:type as attribute
- objectMeasurementsSetComplexType allows for lido:type as attribute
- rightsType allows for lido:type as attribute
- titleSet allows for lido:pref as attribute
- vitalDatesActor allows for lido:type as attribute
mrodzis's avatar
mrodzis committed
116

mrodzis's avatar
mrodzis committed
117
The following other changes have been made:
mrodzis's avatar
mrodzis committed
118

mrodzis's avatar
mrodzis committed
119
120
- <http://schemas.opengis.net/gml/3.1.1/base/gml.xsd> is now in use for GML validation
- instead of defining objectClassificationWrap, classificationWrap, and objectWorkTypeWrap twice, a reference has been introduced