Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typos #200

Closed
wants to merge 8 commits into from
Closed

Typos #200

wants to merge 8 commits into from

Conversation

kinow
Copy link
Contributor

@kinow kinow commented Sep 17, 2018

Hi,

We found a few typos in opengeospatial/geoapi that can probably be ported back to this repository.

I am not sure if I haven't changed one too many files. If so, please let me know and I will edit the commit.

Thanks!
Bruno

Copy link

@desruisseaux desruisseaux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much! But I suggest to split in different pull requests based not on the modified words, but rather on the modified files and modified elements inside the files:

  • All <xs:documentation> or <documentation> elements in XSD files: in my understanding, those ones can be safely changed since they are not programmatic elements.
  • All <gco:CharacterString> elements in codelists.xml file (I think).
  • Any elements incodelists.html file.
  • Maybe *.sch file, but I'm not sure what those files are (but the changes look like in documentation).
  • README.md file.

In particular, I think that the <element> and <identifier> elements in XSD files need to stay unchanged because they are supposed to reflect the ISO 19115 standards. In my understanding, changing those elements would require to change ISO 19115 first.

@@ -22,7 +22,7 @@
<dictionaryEntry>
<Definition gml:id="_12506_19361">
<description>data, usually a physical measurement, used to support the calculation of the primary physicalMeasurement coverages in the dataset (e.g. grid of aerosol optical thickness used in the calculation of a sea surface temperature product).</description>
<identifier codeSpace="http://www.isotc211.org/2014/mrc/1.0/2014-07-11/MD_CoverageContentTypeCode">auxilliaryInformation</identifier>
<identifier codeSpace="http://www.isotc211.org/2014/mrc/1.0/2014-07-11/MD_CoverageContentTypeCode">auxiliaryInformation</identifier>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The typo is in ISO 19115-1 standard, so we may not be able to change it in the XSD (I guess we would need the standard to be changed first).

@@ -433,9 +433,9 @@
</xsl:element>
</xsl:element>
</xsl:template>
<xsl:template match="gmi:objectiveOccurance" mode="from19139to19115-3">
<xsl:template match="gmi:objectiveOccurrence" mode="from19139to19115-3">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to preserve the typo since the intend is to map elements from the old XSD, which used that spelling.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in the UML , the property name is 'objectiveOccurence', so gmi:objectiveOccurance should actually be updated to gmi:objectiveOccurence

<!-- This element is mis-spelled in the 19115-2 schema -->
<xsl:element name="mac:objectiveOccurence">
<xsl:element name="mac:objectiveOccurrence">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to preserve the typo since the intend is to map elements from the old XSD, which used that spelling.

@@ -235,7 +235,7 @@ shortName: trgtExtent</documentation>
</element>
<element maxOccurs="unbounded" minOccurs="0" name="sensingInstrument" type="mac:MI_Instrument_PropertyType"/>
<element maxOccurs="unbounded" minOccurs="0" name="pass" type="mac:MI_PlatformPass_PropertyType"/>
<element maxOccurs="unbounded" name="objectiveOccurence" type="mac:MI_Event_PropertyType"/>
<element maxOccurs="unbounded" name="objectiveOccurrence" type="mac:MI_Event_PropertyType"/>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The typo is in the ISO 19115 specification.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't fix

@@ -241,7 +241,7 @@
</element>
<element maxOccurs="unbounded" minOccurs="0" name="sensingInstrument" type="mac:MI_Instrument_PropertyType"/>
<element maxOccurs="unbounded" minOccurs="0" name="pass" type="mac:MI_PlatformPass_PropertyType"/>
<element maxOccurs="unbounded" name="objectiveOccurence" type="mac:MI_Event_PropertyType"/>
<element maxOccurs="unbounded" name="objectiveOccurrence" type="mac:MI_Event_PropertyType"/>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The typo is in ISO 19115 specification.

@@ -22,7 +22,7 @@
<dictionaryEntry>
<Definition gml:id="_12506_19361">
<description>data, usually a physical measurement, used to support the calculation of the primary physicalMeasurement coverages in the dataset (e.g. grid of aerosol optical thickness used in the calculation of a sea surface temperature product).</description>
<identifier codeSpace="http://standards.iso.org/iso/19115/-3/mrc/1.0">auxilliaryInformation</identifier>
<identifier codeSpace="http://standards.iso.org/iso/19115/-3/mrc/1.0">auxiliaryInformation</identifier>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The typo is in ISO 19115 specification.

<!-- This element is mis-spelled in the 19115-2 schema -->
<xsl:element name="mac:objectiveOccurence">
<xsl:element name="mac:objectiveOccurrence">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to preserve the spelling used by XML elements, even if this is a typo.

Copy link
Contributor

@smrgeoinfo smrgeoinfo Sep 17, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the UML for ISO19115-2 Edition 1 and Edition 2, and in ISO19115-3 Acquisition information - Imagery package, the association from MI_Objective to MI_Event is named 'objectiveOccurence', but in the XML implementation at http://standards.iso.org/iso/19115/-2/gmi/1.0/acquisitionInformation.xsd, it's spelled 'objectiveOccurance'. The spelling 'gmi:objectiveOccurance' must be used in the xsl file, since that's what's in the xml schema. Correcting the typo to match what's in the UML requires an amendment to the spec.
The ISO19115-3 xml implementation (http://standards.iso.org/iso/19115/-3/mac/1.0/acquisitionInformationImagery.xsd) has the typo from the UML (mac:objectiveOccurence)
The xsl has the correct (mis)spellings, don't change

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello all, sorry for delay getting back on this... just too busy these days.

In general the discussion is correct - we can change annotations but not mis-spelled elements (we could do a corrigendum, but may be too late)...

Also wanted to make sure that everyone understands that the annotated schema is not the official schema and is not supported in any way by ISO TC211. It was a project a few people started with the hope that it would be useful and that the community would help support it. Thanks so much for help with the spelling...

Another note - the new and complete schemas have now been uploaded to standards.iso.org. There are a number of new namespaces that have Version 2 directories. I will update those in the annotated schemas soon. We may need a mechanism for transferring annotations across to the new namespace versions... Will also think about that...

@kinow
Copy link
Contributor Author

kinow commented Sep 17, 2018

Thanks for the quick reply @desruisseaux ! Will leave as-is for a couple of days to see what others think, then will start updating as you suggested 🕺

@kinow
Copy link
Contributor Author

kinow commented Sep 19, 2018

Updated the commit to reflect the comments, but will revisit it later to follow @desruisseaux 's first message, and see if there are still files that need to be reverted. Or maybe start separate pull requests...

Thanks everybody for the review!

desruisseaux added a commit to opengeospatial/geoapi that referenced this pull request Sep 19, 2018
Copy link

@desruisseaux desruisseaux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the new changes, they looks good. Attached comments on two elements.

@@ -435,7 +435,7 @@
</xsl:template>
<xsl:template match="gmi:objectiveOccurance" mode="from19139to19115-3">
<!-- This element is mis-spelled in the 19115-2 schema -->
<xsl:element name="mac:objectiveOccurence">
<xsl:element name="objectiveOccurence">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we keep the "mac" prefix?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, my mistake, didn't mean to remove the prefix. Fixing now.

@@ -433,7 +433,7 @@
</xsl:element>
</xsl:element>
</xsl:template>
<xsl:template match="gmi:objectiveOccurance" mode="from19139to19115-3">
<xsl:template match="gmi:objectiveOccurrence" mode="from19139to19115-3">

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While objectiveOccurrence is the correct spelling, I think that the spelling used in ISO 19115-3 was objectiveOccurence with only one "r". So this fix would need to only replace the "a" into "e" without adding "r".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted to gmi:objectiveOccurence. Thanks @desruisseaux !!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants