openminted / omtd-share-annotations

Java annotations and a Maven plugin to automatically generate OMTD-SHARE metadata.
https://openminted.github.io/releases/omtd-share-annotations/
0 stars 1 forks source link

Landing page issues in the produced XML #27

Closed maxxkia closed 6 years ago

maxxkia commented 6 years ago

Below I am pasting a shortened version of the metadata file that was produced for my pdf reader component.

I can spot some problems:

<?xml version="1.0" encoding="UTF-8"?>
<ns1:componentMetadataRecord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://www.meta-share.org/OMTD-SHARE_XMLSchema" xsi:schemaLocation="http://www.meta-share.org/OMTD-SHARE_XMLSchema http://www.meta-share.org/OMTD-SHARE_XMLSchema/v200/OMTD-SHARE-Component.xsd">
  <ns1:componentInfo>
    <ns1:resourceType>component</ns1:resourceType>
    <ns1:identificationInfo>
      <ns1:resourceNames>
        <ns1:resourceName>CERMINE PDF Reader</ns1:resourceName>
      </ns1:resourceNames>
      <ns1:descriptions>
        <ns1:description>Collection reader for PDF files using CERMINE
&lt;a href="https://github.com/CeON/CERMINE"&gt;https://github.com/CeON/CERMINE&lt;/a&gt;.</ns1:description>
      </ns1:descriptions>
      <ns1:resourceIdentifiers>
        <ns1:resourceIdentifier resourceIdentifierSchemeName="maven">mvn:eu.openminted.uc-tdm-socialsciences:ss-io-pdf:1.0.1-SNAPSHOT#eu.openminted.uc.socialsciences.io.pdf.cermine.CerminePdfReader</ns1:resourceIdentifier>
      </ns1:resourceIdentifiers>
      <ns1:public>false</ns1:public>
    </ns1:identificationInfo>
    <ns1:versionInfo>
      <ns1:version>1.0.1-SNAPSHOT</ns1:version>
    </ns1:versionInfo>
    <ns1:contactInfo>
      <ns1:landingPage>https://github.com/openminted/uc-tdm-socialsciences/ss-io-pdf</ns1:landingPage>
      <ns1:contactGroups>
        <ns1:contactGroup>
          <ns1:groupNames>
            <ns1:groupName>eu.openminted.uc-tdm-socialsciences</ns1:groupName>
          </ns1:groupNames>
        </ns1:contactGroup>
        <ns1:contactGroup>
          <ns1:groupNames>
            <ns1:groupName>OpenMinTeD</ns1:groupName>
          </ns1:groupNames>
          <ns1:affiliatedOrganization>
            <ns1:organizationNames>
              <ns1:organizationName>OpenMinTeD</ns1:organizationName>
            </ns1:organizationNames>
          </ns1:affiliatedOrganization>
        </ns1:contactGroup>
      </ns1:contactGroups>
      <ns1:mailingLists>
        <ns1:mailingListInfo>
          <ns1:mailingListName>SS TDM Software Collection developers mailing list</ns1:mailingListName>
          <ns1:subscribe>uc-tdm-socialsciences-developers+subscribe@googlegroups.com</ns1:subscribe>
          <ns1:unsubscribe>uc-tdm-socialsciences-developers+unsubscribe@googlegroups.com</ns1:unsubscribe>
          <ns1:post>uc-tdm-socialsciences-developers@googlegroups.com</ns1:post>
          <ns1:archive>https://groups.google.com/forum/#!forum/uc-tdm-socialsciences-developers</ns1:archive>
        </ns1:mailingListInfo>
      </ns1:mailingLists>
    </ns1:contactInfo>
    <ns1:componentType>reader</ns1:componentType>
    <ns1:application>false</ns1:application>
    <ns1:distributionInfos>
      <ns1:componentDistributionInfo>
        <ns1:componentLoc>
          <ns1:componentDistributionForm>executableCode</ns1:componentDistributionForm>
          <ns1:distributionURL>mvn:eu.openminted.uc-tdm-socialsciences:ss-io-pdf:1.0.1-SNAPSHOT#eu.openminted.uc.socialsciences.io.pdf.cermine.CerminePdfReader</ns1:distributionURL>
        </ns1:componentLoc>
        <ns1:command>eu.openminted.uc.socialsciences.io.pdf.cermine.CerminePdfReader</ns1:command>
        <ns1:operatingSystems>
          <ns1:operatingSystem>os-independent</ns1:operatingSystem>
        </ns1:operatingSystems>
        <ns1:copyrightStatements>
          <ns1:copyrightStatement>Copyright 2016-2017 OpenMinTeD Project http://openminted.eu/</ns1:copyrightStatement>
        </ns1:copyrightStatements>
      </ns1:componentDistributionInfo>
    </ns1:distributionInfos>
    <ns1:inputContentResourceInfo>
      <ns1:processingResourceTypes>
        <ns1:processingResourceType>corpus</ns1:processingResourceType>
      </ns1:processingResourceTypes>
      <ns1:dataFormats>
        <ns1:dataFormatInfo>
          <ns1:fileExtension>pdf</ns1:fileExtension>
        </ns1:dataFormatInfo>
      </ns1:dataFormats>
      <ns1:characterEncodings></ns1:characterEncodings>
      <ns1:keywords></ns1:keywords>
      <ns1:parameterInfos>
        <ns1:parameterInfo>
          <ns1:parameterName>headingType</ns1:parameterName>
          <ns1:parameterLabel>headingType</ns1:parameterLabel>
          <ns1:parameterDescription>The type used to annotate headings.</ns1:parameterDescription>
          <ns1:parameterType>string</ns1:parameterType>
          <ns1:optional>true</ns1:optional>
          <ns1:multiValue>false</ns1:multiValue>
          <ns1:defaultValue>&lt;built-in&gt;</ns1:defaultValue>
        </ns1:parameterInfo>
      </ns1:parameterInfos>
    </ns1:inputContentResourceInfo>
    <ns1:outputResourceInfo>
      <ns1:processingResourceTypes>
        <ns1:processingResourceType>corpus</ns1:processingResourceType>
      </ns1:processingResourceTypes>
      <ns1:dataFormats>
        <ns1:dataFormatInfo>
          <ns1:mimeType>application/pdf</ns1:mimeType>
        </ns1:dataFormatInfo>
        <ns1:dataFormatInfo>
          <ns1:fileExtension>xmi</ns1:fileExtension>
        </ns1:dataFormatInfo>
      </ns1:dataFormats>
      <ns1:characterEncodings></ns1:characterEncodings>
      <ns1:keywords></ns1:keywords>
    </ns1:outputResourceInfo>
    <ns1:componentCreationInfo>
      <ns1:framework>UIMA</ns1:framework>
      <ns1:implementationLanguage>Java</ns1:implementationLanguage>
    </ns1:componentCreationInfo>
    <ns1:scmInfo>
      <ns1:connection>scm:git:git://github.com/openminted/uc-tdm-socialsciences/ss-io-pdf</ns1:connection>
      <ns1:developerConnection>scm:git:git@github.com:openminted/uc-tdm-socialsciences.git/ss-io-pdf</ns1:developerConnection>
      <ns1:tag>HEAD</ns1:tag>
      <ns1:url>https://github.com/openminted/uc-tdm-socialsciences/ss-io-pdf</ns1:url>
    </ns1:scmInfo>
    <ns1:issueManagementInfo>
      <ns1:system>GitHub Issues</ns1:system>
      <ns1:url>https://github.com/openminted/uc-tdm-socialsciences/issues</ns1:url>
    </ns1:issueManagementInfo>
  </ns1:componentInfo>
</ns1:componentMetadataRecord>
reckart commented 6 years ago

<ns1:landingPage>, <ns1:scmInfo>, connection, developerConnection and url are obtained directly from Maven. I assume that Maven automatically internally extends these settings as part of the POM inheritance process.

reckart commented 6 years ago

It is something beyond our control - i.e. it is a Maven issue, not an OMTD issue. Regarding the URL, I have opened a Maven issue (https://issues.apache.org/jira/browse/MNG-6384) - however, I expect the "solution" has to be that all the elements need to be redeclared in the child modules with the same values as in the parent module to prevent this behavior.