CDC DDI-C: Add citation, language tag etc. for related publication

katja-moilanen commented 4 months ago

In latest DDI-C profiles, there is only place for PID and URI (one option). For CDC also citation information is important.

Mistake in IDNo Required: Recommended</r:Content> and in it is Optional. Should be optional because there are many datasets without related publications.

Change /codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@URI as optional too

katja-moilanen commented 2 months ago

Add missing language information especially for multilingual profiles but also to monolingual profiles, because there might be publications having different language than the (other) metadata.

katja-moilanen commented 2 months ago

CDC now accepts 3 different sources for the bibliographic citation for the related publication: https://github.com/cessda/cessda.cdc.osmh-indexer.cmm/blob/9c3d4c6e0d0fde2452b3c0ed1d738898e337738b/src/main/java/eu/cessda/pasc/oci/parser/ParsingStrategies.java#L300 . //relPubl, //relPubl/citation/titlStmt/titl and //relPubl/citation/biblCit

And for the URI of the document, there are 2 options for DDI-C 2.5 and 1.2.2 (when using https://ddialliance.org/Version1-2-2.xsd): /codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@URI and /codeBook/stdyDscr/othrStdyMat/relPubl/ExtLink/@URI And 1 option /codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@URI for DDI-C 2.6 (which does not have ExtLink)

katja-moilanen commented 2 months ago

monolingual DDI-C 2.6

    <!--****************************************************************************************-->
    <!--RELATED PUBLICATIONS -->
    <!--****************************************************************************************-->
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: First option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/@xml:lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication. This not always the same as the metadata language and therefore this is useful for monolingual profile, too. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1/9.8.1.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/titl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Second option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: PID of the publication. Required by OpenAire to to relate the
                publication to a dataset.</r:Content>
            <r:Content>CMM_Mapping: 9.9</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo/@agency"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Mandatory if '..../IDNo' element is present.</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Agency responsible for the identifier of the publication. Required by
                OpenAire and the value has to come from their controlled list of
                relatedIdentifierTypes:
                https://guidelines.openaire.eu/en/latest/data/field_relatedidentifier.html#d-relatedidentifier..</r:Content>
            <r:Content>CMM_Mapping: 9.9.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content>
                <![CDATA[
                <Constraints>
                    <MandatoryNodeIfParentPresentConstraint/>
                </Constraints>
                ]]>
            </r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/biblCit"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Third option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: URL of website on which the publication can be found (or at least information concerning
                the literature).</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>

katja-moilanen commented 2 months ago

multilingual DDI-C 2.6:

     <!--****************************************************************************************-->
    <!--RELATED PUBLICATIONS -->
    <!--****************************************************************************************-->
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: First option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/@xml:lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication. This not always the same as the metadata language and therefore this is useful for monolingual profile, too. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1/9.8.1.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
   <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/titl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Second option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
<pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/titl/@xml:lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication title. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: PID of the publication. Required by OpenAire to to relate the
                publication to a dataset.</r:Content>
            <r:Content>CMM_Mapping: 9.9</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo/@agency"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Mandatory if '..../IDNo' element is present.</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Agency responsible for the identifier of the publication. Required by
                OpenAire and the value has to come from their controlled list of
                relatedIdentifierTypes:
                https://guidelines.openaire.eu/en/latest/data/field_relatedidentifier.html#d-relatedidentifier..</r:Content>
            <r:Content>CMM_Mapping: 9.9.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content>
                <![CDATA[
                <Constraints>
                    <MandatoryNodeIfParentPresentConstraint/>
                </Constraints>
                ]]>
            </r:Content>
        </pr:Instructions>
    </pr:Used>
<pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/biblCit"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Third option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/biblCit/@xml:lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication title. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: URL of website on which the publication can be found (or at least information concerning
                the literature).</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
   <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@xml:lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the publication website. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: None</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>

katja-moilanen commented 1 month ago

Monolingual DDI-C 1.2.2

 <!--****************************************************************************************-->
    <!--RELATED PUBLICATIONS -->
    <!--****************************************************************************************-->
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: First option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
  <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/@xml-lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication. This not always the same as the metadata language and therefore this is useful for monolingual profile, too. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1/9.8.1.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/ExtLink/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: URL of website on which the publication can be found (or at least information concerning
                the literature).</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/titl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Second option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: PID of the publication. Required by OpenAire to to relate the
                publication to a dataset.</r:Content>
            <r:Content>CMM_Mapping: 9.9</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo/@agency"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Mandatory if '..../IDNo' element is present.</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Agency responsible for the identifier of the publication. Required by
                OpenAire and the value has to come from their controlled list of
                relatedIdentifierTypes:
                https://guidelines.openaire.eu/en/latest/data/field_relatedidentifier.html#d-relatedidentifier..</r:Content>
            <r:Content>CMM_Mapping: 9.9.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content>
                <![CDATA[
                <Constraints>
                    <MandatoryNodeIfParentPresentConstraint/>
                </Constraints>
                ]]>
            </r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/biblCit"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Third option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: URL of website on which the publication can be found (or at least information concerning
                the literature).</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>

katja-moilanen commented 1 month ago

Multilingual 1.2.2

     <!--****************************************************************************************-->
    <!--RELATED PUBLICATIONS -->
    <!--****************************************************************************************-->
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: First option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/@xml-lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication. This not always the same as the metadata language and therefore this is useful for monolingual profile, too. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1/9.8.1.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/ExtLink/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: URL of website on which the publication can be found (or at least information concerning
                the literature).</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/ExtLink/@xml-lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of website on which the publication can be found (or at least information concerning
                the literature). ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/titl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Second option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/titl/@xml-lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication title. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: PID of the publication. Required by OpenAire to to relate the
                publication to a dataset.</r:Content>
            <r:Content>CMM_Mapping: 9.9</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo/@agency"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Mandatory if '..../IDNo' element is present.</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Agency responsible for the identifier of the publication. Required by
                OpenAire and the value has to come from their controlled list of
                relatedIdentifierTypes:
                https://guidelines.openaire.eu/en/latest/data/field_relatedidentifier.html#d-relatedidentifier..</r:Content>
            <r:Content>CMM_Mapping: 9.9.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content>
                <![CDATA[
                <Constraints>
                    <MandatoryNodeIfParentPresentConstraint/>
                </Constraints>
                ]]>
            </r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/biblCit"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Third option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/biblCit/@xml-lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication title. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: URL of website on which the publication can be found (or at least information concerning
                the literature).</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@xml-lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the publication website. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: None</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>

katja-moilanen commented 1 month ago

DDI-C 2.5 monolingual

    <!--****************************************************************************************-->
    <!--RELATED PUBLICATIONS -->
    <!--****************************************************************************************-->
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: First option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/@xml:lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication. This not always the same as the metadata language and therefore this is useful for monolingual profile, too. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1/9.8.1.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
 <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/ExtLink/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: URL of website on which the publication can be found (or at least information concerning
                the literature).</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/titl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Second option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: PID of the publication. Required by OpenAire to to relate the
                publication to a dataset.</r:Content>
            <r:Content>CMM_Mapping: 9.9</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo/@agency"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Mandatory if '..../IDNo' element is present.</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Agency responsible for the identifier of the publication. Required by
                OpenAire and the value has to come from their controlled list of
                relatedIdentifierTypes:
                https://guidelines.openaire.eu/en/latest/data/field_relatedidentifier.html#d-relatedidentifier..</r:Content>
            <r:Content>CMM_Mapping: 9.9.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content>
                <![CDATA[
                <Constraints>
                    <MandatoryNodeIfParentPresentConstraint/>
                </Constraints>
                ]]>
            </r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/biblCit"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Third option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: URL of website on which the publication can be found (or at least information concerning
                the literature).</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>

katja-moilanen commented 1 month ago

multilingual DDI-C 2.5

     <!--****************************************************************************************-->
    <!--RELATED PUBLICATIONS -->
    <!--****************************************************************************************-->
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: First option for bibliographic citation of the related publication.</r:Content>
        <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/@xml:lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication. This not always the same as the metadata language and therefore this is useful for monolingual profile, too. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1/9.8.1.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
 <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/ExtLink/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: URL of website on which the publication can be found (or at least information concerning
                the literature).</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/ExtLink/@xml:lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of website on which the publication can be found (or at least information concerning
                the literature). ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/titl"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Second option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/titl/@xml:lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication title. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: PID of the publication. Required by OpenAire to to relate the
                publication to a dataset.</r:Content>
            <r:Content>CMM_Mapping: 9.9</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo/@agency"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Mandatory if '..../IDNo' element is present.</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Agency responsible for the identifier of the publication. Required by
                OpenAire and the value has to come from their controlled list of
                relatedIdentifierTypes:
                https://guidelines.openaire.eu/en/latest/data/field_relatedidentifier.html#d-relatedidentifier..</r:Content>
            <r:Content>CMM_Mapping: 9.9.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content>
                <![CDATA[
                <Constraints>
                    <MandatoryNodeIfParentPresentConstraint/>
                </Constraints>
                ]]>
            </r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/biblCit"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Content element</r:Content>
            <r:Content>ElementRepeatable: Yes</r:Content>
            <r:Content>Usage: Third option for bibliographic citation of the related publication.</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.11</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/biblCit/@xml:lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the related publication title. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: 9.5.1</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@URI"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: URL of website on which the publication can be found (or at least information concerning
                the literature).</r:Content>
            <r:Content>CDC_UI_Label: Related publications</r:Content>
            <r:Content>CMM_Mapping: 9.10</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>
    <pr:Used xpath="/codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@xml:lang"
        isRequired="false">
        <r:Description>
            <r:Content>Required: Optional</r:Content>
            <r:Content>ElementType: Attribute</r:Content>
            <r:Content>Usage: Language of the publication website. ISO 639-1 codes are strongly encouraged
                to be used.</r:Content>
            <r:Content>CMM_Mapping: None</r:Content>
        </r:Description>
        <pr:Instructions>
            <r:Content><![CDATA[
            <Constraints>
                <OptionalNodeConstraint/>
            </Constraints>
            ]]></r:Content>
        </pr:Instructions>
    </pr:Used>

cessda / cessda.metadata.profiles

CDC DDI-C: Add citation, language tag etc. for related publication #163