# Revision history
# 2010-08-26   Complete revision according to new common specification by the metadata work group after review. AJH, DTIC
#     2010-11-17 Revised to current state of kernel review, FZ, TIB 
#     2011-01-17 Complete revsion after community review. FZ, TIB
#     2011-03-17 Release of v2.1: added a namespace; mandatory properties got minLength; changes in the definitions of relationTypes
#     IsDocumentedBy/Documents and isCompiledBy/Compiles; changes type of property "Date" from xs:date to xs:string. FZ, TIB
#     2011-06-27 v2.2: namespace: kernel-2.2, additions to controlled lists "resourceType", "contributorType", "relatedIdentifierType", and "descriptionType". Removal of intermediate include-files.
# 2013-05 v3.0: namespace: kernel-3.0; delete LastMetadataUpdate & MetadateVersionNumber; additions to controlled lists "contributorType", "dateType", "descriptionType", "relationType", "relatedIdentifierType" & "resourceType"; deletion of "StartDate" & "EndDate" from list "dateType" and "Film" from "resourceType";  allow arbitrary order of elements; allow optional wrapper elements to be empty; include xml:lang attribute for title, subject & description; include attribute schemeURI for nameIdentifier of creator, contributor & subject; added new attributes "relatedMetadataScheme", "schemeURI" & "schemeType" to relatedIdentifier; included new property "geoLocation"

default namespace = "http://datacite.org/schema/kernel-3"
namespace a = "http://relaxng.org/ns/compatibility/annotations/1.0"
namespace rng = "http://relaxng.org/ns/structure/1.0"
namespace xsi = "http://www.w3.org/2001/XMLSchema-instance"

start = resource

titleType = "AlternativeTitle" | "Subtitle" | "TranslatedTitle"

## 
##			The type of contributor of the resource.
##		
contributorType =
  "ContactPerson"
  | "DataCollector"
  | "DataManager"
  | "Distributor"
  | "Editor"
  | "Funder"
  | "HostingInstitution"
  | "Other"
  | "Producer"
  | "ProjectLeader"
  | "ProjectManager"
  | "ProjectMember"
  | "RegistrationAgency"
  | "RegistrationAuthority"
  | "RelatedPerson"
  | "ResearchGroup"
  | "RightsHolder"
  | "Researcher"
  | "Sponsor"
  | "Supervisor"
  | "WorkPackageLeader"

## 
##			The type of date. Use RKMS‐ISO8601 standard for depicting date ranges.To indicate the end of an embargo period, use Available. To indicate the start of an embargo period, use Submitted or Accepted, as appropriate.
##		
dateType =
  "Accepted"
  | "Available"
  | "Collected"
  | "Copyrighted"
  | "Created"
  | "Issued"
  | "Submitted"
  | "Updated"
  | "Valid"

## 
##			The general type of a resource.
##		
resourceType =
  "Audiovisual"
  | "Collection"
  | "Dataset"
  | "Event"
  | "Image"
  | "InteractiveResource"
  | "Model"
  | "PhysicalObject"
  | "Service"
  | "Software"
  | "Sound"
  | "Text"
  | "Workflow"
  | "Other"

## 
##			Description of the relationship of the resource being registered (A) and the related resource (B).
##		
relationType =
  "IsCitedBy"
  | "Cites"
  | "IsSupplementTo"
  | "IsSupplementedBy"
  | "IsContinuedBy"
  | "Continues"
  | "IsNewVersionOf"
  | "IsPreviousVersionOf"
  | "IsPartOf"
  | "HasPart"
  | "IsReferencedBy"
  | "References"
  | "IsDocumentedBy"
  | "Documents"
  | "IsCompiledBy"
  | "Compiles"
  | "IsVariantFormOf"
  | "IsOriginalFormOf"
  | "IsIdenticalTo"
  | "HasMetadata"
  | "IsMetadataFor"

## 
##			The type of the RelatedIdentifier.
##		
relatedIdentifierType =
  "ARK"
  | "DOI"
  | "EAN13"
  | "EISSN"
  | "Handle"
  | "ISBN"
  | "ISSN"
  | "ISTC"
  | "LISSN"
  | "LSID"
  | "PMID"
  | "PURL"
  | "UPC"
  | "URL"
  | "URN"
## 
##			The type of the description.
##		

descriptionType =
  "Abstract"
  | "Methods"
  | "SeriesInformation"
  | "TableOfContents"
  | "Other"

resource =
  
  ## 
  ##			
  ##	Root element of a single record. This wrapper element is for XML implementation only and is not defined in the DataCite DOI standard.
  ##         Note: This is the case for all wrapper elements within this schema!
  ##			No content in this wrapper element.
  ##		
  element resource {
    attribute xsi:schemaLocation { text }? &
    
    ## REQUIRED
    ##						A persistent identifier that identifies a resource.
    ##						Currently, only DOI is allowed.
    ##					
    element identifier {
      attribute identifierType { "DOI" },
      doiType
    }
    & element creators {
        
        ## REQUIRED
        ##									The main researchers involved working on the data, or the authors of the publication in priority order. May be a corporate/institutional or personal name.
        ##									Format: Family, Given.
        ##								
        element creator {
          element creatorName { nonemptycontentStringType },
          element nameIdentifier {
            attribute nameIdentifierScheme { text },
            attribute schemeURI { xsd:anyURI }?,
	    nonemptycontentStringType
          }?
        }+
      }
    & element titles {
        
        ## REQUIRED
        ##									A name or title by which a resource is known.
        ##								
        element title {
          attribute titleType { titleType }?,
          lang?,
	  nonemptycontentStringType
        }+
      }
    & 
      ## REQUIRED
      ##						The name of the entity that holds, archives, publishes prints, distributes, releases, issues, or produces the resource. This property will be used to formulate the citation, so consider the prominence of the role.
      ##						In the case of datasets, "publish" is understood to mean making the data available to the community of researchers.
      ##					
      element publisher { nonemptycontentStringType }
    & 
      ## REQUIRED
      ##						Year when the data is made publicly available. If an embargo period has been in effect, use the date when the embargo period ends.
      ##						In the case of datasets, "publish" is understood to mean making the data available on a specific date to the community of researchers. If there is no standard publication year value, use the date that would be preferred from a citation perspective.
      ##						YYYY
      ##					
      element publicationYear { yearType }
    & element subjects {
        
        ## 
        ##									Subject, keywords, classification codes, or key phrases describing the resource.
        ##								
        element subject {
          attribute subjectScheme { text }?,
          attribute schemeURI { xsd:anyURI }?,
          lang?,
	  text
        }*
      }?
    & element contributors {
        
        ## 
        ##									The institution or person responsible for collecting, creating, or otherwise contributing to the developement of the dataset.
        ##									The personal name format should be: Family, Given.
        ##								
        element contributor {
          element contributorName { xsd:string },
          element nameIdentifier {
            attribute nameIdentifierScheme { text },
            attribute schemeURI { xsd:anyURI }?,
	    nonemptycontentStringType
          }?,
          attribute contributorType { contributorType }
        }*
      }?
    & element dates {
        
        ## 
        ##									Different dates relevant to the work.
        ##									YYYY,YYYY-MM-DD, YYYY-MM-DDThh:mm:ssTZD or any other format or level of granularity described in W3CDTF. Use RKMS-ISO8601 standard for depicting date ranges.
        ##								
        element date {
          attribute dateType { dateType },
	  text
        }*
      }?
    & element language {
        
        ## 
        ##						Primary language of the resource. Allowed values are taken from  IETF BCP 47, ISO 639-1 language codes.
        ##					
        xsd:language
      }?
    & 
      ## 
      ##						The type of a resource. You may enter an additional free text description.
      ##						The format is open, but the preferred format is a single term of some detail so that a pair can be formed with the sub-property.
      ##					
      element resourceType {
        attribute resourceTypeGeneral { resourceType },
	text
      }?
    & element alternateIdentifiers {
        
        ## 
        ##									An identifier or identifiers other than the primary Identifier applied to the resource being registered. This may be any alphanumeric string which is unique within its domain of issue. May be used for local identifiers. AlternateIdentifier should be used for another identifier of the same instance (same location, same file).
        ##								
        element alternateIdentifier {
          attribute alternateIdentifierType { text },
	  text
        }*
      }?
    & element relatedIdentifiers {
        
        ## 
        ##									Identifiers of related resources. Use this property to indicate subsets of properties, as appropriate.
        ##								
        element relatedIdentifier {
          attribute relatedIdentifierType { relatedIdentifierType },
          attribute relationType { relationType },
          attribute relatedMetadataScheme { text }?,
          attribute schemeURI { xsd:anyURI }?,
          attribute schemeType { text }?,
	  text
        }*
      }?
    & element sizes {
        element size {
          
          ## 
          ##									Unstructures size information about the resource.
          ##								
          xsd:string
        }*
      }?
    & element formats {
        element format {
          
          ## 
          ##									Technical format of the resource.
          ##									Use file extension or MIME type where possible.
          ##								
          xsd:string
        }*
      }?
    & element version {
        
        ## 
        ##						Version number of the resource. If the primary resource has changed the version number increases.
        ##						Register a new identifier for a major version change. Individual stewards need to determine which are major vs. minor versions. May be used in conjunction with properties 11 and 12 (AlternateIdentifier and RelatedIdentifier) to indicate various information updates. May be used in conjunction with property 17 (Description) to indicate the nature and file/record range of version.
        ##					
        xsd:string
      }?
    & element rightsList {
        
        ## 
        ##									Any rights information for this resource. Provide a rights management statement for the resource or reference a service providing such information. Include embargo information if applicable. 
        ## Use the complete title of a license and include version information if applicable.
        ##								
        element rights {
          attribute rightsURI { xsd:anyURI }?,
	  text
        }*
      }?
    & element descriptions {
        
        ## 
        ##									All additional information that does not fit in any of the other categories. May be used for technical information. It is a best practice to supply a description.
        ##								
        element description {
          attribute descriptionType { descriptionType },
          lang?,
	  # mixed content
          (element br { empty } | text)*
        }*
      }?
    & element geoLocations {
        
        ## 
        ##									Spatial region or named place where the data was gathered or about which the data is focused.
        ##									A point contains a single latitude-longitude pair, separated by whitespace.
        ##									A box contains two white space separated latitude-longitude pairs, with each pair separated by whitespace. The first pair is the lower corner, the second is the upper corner.
        ##								
        element geoLocation {
          element geoLocationPoint { point }?,
          element geoLocationBox { box }?,
          element geoLocationPlace { text }?
        }*
      }?
  }
# TYPE DECLARATIONS

# defines the value for a DOI: DOI must start with "10."
doiType = xsd:token { pattern = "10\..+/.+" }
# defines value for mandatory fields
nonemptycontentStringType = xsd:string { minLength = "1" }
nameId =
  attribute nameIdentifier { xsd:string }?,
  attribute nameIdentifierScheme { xsd:string }?
# defines the value for a year
yearType =
  xsd:token { pattern = "[\d]{4}" }
  # definitions for geoLocation
  
point = list { xsd:double, xsd:double }

box = list { xsd:double, xsd:double, xsd:double, xsd:double }

lang = attribute xml:lang { xsd:language | empty }