opengeospatial / cdb-volume-1

Repository for OGC CDB Volume 1
http://www.github.com/opengeospatial/cdb-volume-1
2 stars 2 forks source link

URI namespace of specification elements breaks OGC-NA policy #12

Open ghobona opened 4 years ago

ghobona commented 4 years ago

CDB 1.1 Volume 1 states that:

The normative provisions in this standard are denoted by the URI

    http://www.opengis.net/spec/cdb/1.0/core/{requirement}

All requirements and conformance tests that appear in this document are denoted by partial URIs which are relative to this base.

For the sake of brevity, the use of “req” in a requirement URI denotes:
    http://www.opengis.net/spec/cdb/1.0

The text above does not comply with OGC-NA policy. Please see Sections 5.3 and 5.4 of OGC-NA Name type specification - specification elements (10-103) http://portal.opengeospatial.org/files/?artifact_id=39194

The text implies that ‘req’ replaces 'http://www.opengis.net/spec/cdb/1.0’.

To fix this, I recommend that the text be changed to say.

The normative provisions in this standard are denoted by the URI namespace

    http://www.opengis.net/spec/cdb/1.1/core

All requirements that appear in this document are denoted by partial URIs which are relative to the namespace shown above.

For the sake of brevity, the use of “req” in a requirement URI denotes:
      http://www.opengis.net/spec/cdb/1.1/core/req

All conformance tests that appear in this document are denoted by partial URIs which are relative to the namespace shown above.

For the sake of brevity, the use of “conf” in a requirement URI denotes:
        http://www.opengis.net/spec/cdb/1.1/core/conf   

This issue may affect CDB 1.2 as well. So that document needs to be checked too.

cnreediii commented 4 years ago

@ghobona - One little (or maybe not). All of the requirement and conformance URIs still state "1.0" for the version. The reason for this is that none of the requirements have changed except for Requirements 74 and 88 which were changed for version 1.2. I am not sure we need to change the version number if nothing has changed :-)

cnreediii commented 4 years ago

Other than that, I made the suggested change.

ghobona commented 4 years ago

@cnreediii

If using different version numbers in the namespaces of requirements, it means that /req cannot be used as shorthand for a particular namespace in Requirements 74 and 88.

I also note that the URIs for Requirements 74 and 88 still identify them as v1.0 requirements and not v1.2

The most efficient way to update the URIs is to update them all by changing the namespace in the Conventions section. You would then also need to run a find-replace operation on each volume.

cnreediii commented 4 years ago

@ghobona - So I changed Reqs 74 and 88 to state that they are 1.2 requirements. I did not use the shorthand form but the full URI. The Conventions section states the shorthand form as 1.0. Personally, I simply do not have time to go through all the volumes and change URIs to 1.2. also, given that none of the other 150+ requirements have changed, I suspect that they do not need to be changed. Does not hurt anything - does it? FYI, I do not use UNIX nor do I use Git desktop. I do everything direct to AsciiDoc files via the web browser app.