Commit c8c468e5 authored by mrodzis's avatar mrodzis 🌎
Browse files

update README (closes #53)

parent 15982055
# LIDO version 1.1 DRAFT
Experimental Draft version of proposed elements/attributes to address issues with LIDO 1.0.
**Do no use in production!**
# LIDO version 1.1
## What's new in LIDO v1.1
### General
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-draft.xsd>.
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>.
For the development of LIDO v1.1 the following criteria for taking into account suggestions for changes and extensions have been defined:
* 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.
- 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.
### General changes
* The schema and the docs are provided in a single XSD document from which different outputs (HTML, PDF, parsed-down XSD [TBD]) are serialized.
* 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
* cross-links between LIDO elements
* though provided in the docs, the following aspect will not be serialized in the PDF and HTML: 'How to record', 'Notes' (both outdated and largely merged into the element description), CIDOC CRM equivalents (not compiled yet)
* We introduced Schematron as a second quality assurance mechanism. This is e.g. used to ensure that dates comply to the xs:dateTime requirements.
* Added the TEI header into the schema. *This solution is tentative, and the header is yet to be updated.*
* 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.
#### 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:
### New elements (and why they have been introduced)
- 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**
**applicationProfile**: Serves as an identifier for a LIDO application profile which has been developed by an institution or project. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L3025>
#### Schematron
**conceptElementsSet**: Increases the schema's modularity. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L6785>
We introduced Schematron as a second quality assurance mechanism. This is e.g. used to ensure that dates comply to the xs:dateTime requirements.
**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. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L6820>
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`.
**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. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L5218>
### New Elements (and Why They Have Been Introduced)
**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. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L5401>
- **applicationProfile**: Serves as an identifier for a LIDO application profile which has been developed by an institution or project.
**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. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L2288>
- **conceptElementsSet**: Increases the schema's modularity.
**mostNotableEvent**: Qualifies an eventSet as the most notable or significant event as designated by the describing institution. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L3490>
- **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.
**objectDescriptionRights**: Allows for setting separate rights information for the object description. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L3749>
- **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.
**objectMaterialsTechSet/objectMaterialsTechWrap**: Allows for materials/technique information (meant like a physical characteristic of the object) outside of events. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L4193>
- **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.
**rightsHolderComplexType**: Increases the schema's modularity. rightsHolder doesn't have to be defined fully twice. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L6162>
- **objectDescriptionRights**: Allows for setting separate rights information for the object description.
**textAttributesSet**: Increases the schema's modularity. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L6814>
- **objectMaterialsTechSet/objectMaterialsTechWrap**: Allows for materials/technique information (meant like a physical characteristic of the object) outside of events.
**vitalPlaceActor**: Allows for providing the birth/death/activity place of an actor. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L383>
- **sourceActorInRole**: Allows for providing source information about an actor in a certain role.
---
- **sourceRelatedWorkSet**: Allows for providing source information about a related work.
**owl:sameAs**: Introduced for all elements that have an actorComplexType, placeComplexType or legalBodyRefComplexType. It enables acquisitors to directly identify an entity via an LOD reference. OWL has been implemented as xs:any and been restricted by Schematron.
- **sourceRepositorySet**: Allows for providing source information about a current or former repository.
**skos:Concept**: Introduced for all elements with a concept(Mixed)ComplexType. This enables acquisitors to make an LOD reference for a term via SKOS. SKOS has been implemented as xs:any and been restricted by Schematron. Link: <https://gitlab.gwdg.de/lido/development/-/blob/develop/1.1/lido-v1.1-draft.xsd#L6788>
- **textAttributesSet**: Increases the schema's modularity.
### New attributes (and why they have been introduced)
- **vitalPlaceActor**: Allows for providing the birth/death/activity place of an actor.
**measurementsGroup**: Indicates the group of measurements given in multiple LIDO Measurement Set elements. Of relevance for the EODEM application profile.
### New Attributes (and Why They Have Been Introduced)
### Changed content model
- **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
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:
* attributionQualifierActor
* extentActor
* extentMaterialsTech
* extentSubject
* enderActor
* measurementType
* measurementUnit
- 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.
### Changed descriptions
### Other Changes
Definitions have generally been renamed to 'description's since they aren't definitions in the Aristotelian sense. The following descriptions have been changed:
The following elements can now hold additional attributes:
* lidoRecID
* subjectConcept
- 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
### Other changes
The following other changes have been made:
* titleSet allows for lido:pref as attribute
- <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
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment