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

Re-sync with Main #55

Merged
merged 43 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
f882be0
Remove redundent clauses that are now in fundamentals
cnreediii Dec 13, 2024
251fe67
Shorten for Part 2
cnreediii Dec 13, 2024
b57ba2c
Delete sources/document.err.html
cnreediii Dec 13, 2024
4109cf1
Create ae-acknowledgements.adoc
cnreediii Dec 13, 2024
0ef7c7b
Move acknowledgements to annex E
cnreediii Dec 13, 2024
651b35f
Add acknowledgements annex
cnreediii Dec 13, 2024
affff17
Update ae-acknowledgements.adocAnnex D not E
cnreediii Dec 13, 2024
53d9cf5
Fix bookmarks and Standardization goal wording.
cnreediii Dec 13, 2024
b083ad9
Fix bookmarks, chnage Policy to ModSpec
cnreediii Dec 13, 2024
eb7204f
Fixing bookmarks and Note
cnreediii Dec 13, 2024
c69dc12
Add note to requirement 0
cnreediii Dec 13, 2024
3fc454a
Add confromance suite back in.
cnreediii Dec 13, 2024
6ea7506
Change class name specification to standard.
cnreediii Dec 13, 2024
0a2b1d5
More bookmarks
cnreediii Dec 13, 2024
9c423b2
Fix a bookmark
cnreediii Dec 13, 2024
1ba0767
Fix bookmark
cnreediii Dec 13, 2024
cdd82aa
Test
cnreediii Dec 14, 2024
3df51f4
Rewrite first two sentences
cnreediii Dec 14, 2024
74f64b8
A bit more wordsmithing
cnreediii Dec 14, 2024
8a608a2
Word smithing and remove one note.
cnreediii Dec 14, 2024
990f4f1
Update 00-preface.adoc
cnreediii Dec 14, 2024
89a293e
Word smithing and remove duplicate content.
cnreediii Dec 14, 2024
2d8eaf6
Update 01-scope.adoc
cnreediii Dec 14, 2024
7b0a3fd
CLean up - remove a few dozen cross references - too messy.
cnreediii Dec 15, 2024
5c96365
Fix some cross references.
cnreediii Dec 15, 2024
6f55ad9
Update 04-terms-and-defs.adoc
cnreediii Dec 15, 2024
e41bfe6
Fixing cross references
cnreediii Dec 15, 2024
944c666
Fix some cross references and add more wording to specification
cnreediii Dec 16, 2024
82c3087
Edit Standrdization goal.
cnreediii Dec 16, 2024
64d84ac
And hopefully final cleanup of bookmarks
cnreediii Dec 16, 2024
67ec77c
Stop double headings
cnreediii Dec 16, 2024
16aa2cd
Some additional edits. Make sure requirements module, req class hiera…
cnreediii Dec 16, 2024
a909de0
Create ogc-modspec-policy.adoc
cnreediii Dec 16, 2024
dbda971
Rename sources/ogc-modspec-policy.adoc to sources/ogc-modspec-policy/…
cnreediii Dec 16, 2024
56f5f0d
Create 00-forward.adoc
cnreediii Dec 16, 2024
fb8662f
Create 00-preface.adoc
cnreediii Dec 16, 2024
84a09c5
Update document.adoc
cnreediii Dec 16, 2024
af20b79
Create 06-policy.adoc
cnreediii Dec 16, 2024
865a95e
Create 01-scope.adoc
cnreediii Dec 16, 2024
36323f4
Create 02-conformance.adoc
cnreediii Dec 16, 2024
883ad26
Update document.adoc
cnreediii Dec 16, 2024
2687d90
remove unnecessary entries
cnreediii Dec 16, 2024
b3a52b1
Duplicate Citations
cmheazel Dec 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sources/document.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,4 @@ include::sections/ac-definitions.adoc[]

include::sections/ad-bibliography.adoc[]

include::sections/ae-acknowledgements.adoc[]
1,104 changes: 211 additions & 893 deletions sources/document.err.html

Large diffs are not rendered by default.

2,385 changes: 704 additions & 1,681 deletions sources/document.html

Large diffs are not rendered by default.

Binary file modified sources/document.pdf
Binary file not shown.
7,233 changes: 2,388 additions & 4,845 deletions sources/document.presentation.xml

Large diffs are not rendered by default.

2,585 changes: 594 additions & 1,991 deletions sources/document.xml

Large diffs are not rendered by default.

2,676 changes: 2,676 additions & 0 deletions sources/document.xml.abort

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions sources/models/ogc-modspec.lutaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
diagram OGCModSpec {
title "OGC 08-131r3 ModSpec"

class Specification {
class Standard {
definition {
For a draft standard (aka specification) to become an international standard, the document must be approved by an authority,
such as ISO or the OGC. The attributes of a standard describe its local name, its authority, the date of publication
Expand Down Expand Up @@ -36,9 +36,9 @@ diagram OGCModSpec {

class ConformanceSuite {
definition {
The unique conformance suite of a standard lists the tests (grouped
into conformance test classes consisting of some number of conformance
test modules, containing some number of conformance tests) that allow
The unique conformance suite of a standard lists the tests (possibly grouped
into conformance test modules consisting of some number of conformance
test classes, each containing some number of conformance tests) that allow
testing of an implementation of the standard for conformance with the
requirements stated in the standard. Every standard needs one of these suites, or
conformance cannot be claimed with proof. In ISO and the OGC, the conformance
Expand All @@ -64,7 +64,7 @@ diagram OGCModSpec {
definition {
The requirements in the requirements classes of a standard must be
tested and the conformance classes are the containers for these tests’
definition. The requirements classes will have interdependencies, and this
definition. The requirements classes may have interdependencies, and this
is reflected in the explicit dependencies between the conformance classes.
If class "a" is dependent on class "b", then to pass the test for "a" a
standardization target must also pass the test for "b." The class name is
Expand Down Expand Up @@ -112,7 +112,7 @@ diagram OGCModSpec {
}
modules: RequirementsModule[1..*] {
definition {
Requirements modules that make up this requirements class.
A set of one or more requirement(s) classes, recommendations, and permissions with the same standardization target.
}
}
targetType: StandardizationTargetType {
Expand All @@ -124,7 +124,7 @@ diagram OGCModSpec {

class RequirementsModule {
definition {
A requirements modules (usually realized as groups of one or more
A requirements module (usually realized as groups of one or more
requirements classes in the standard) group the
requirements and recommendations in the standard in a manner consistent with the
conformance test modules.
Expand All @@ -138,7 +138,7 @@ diagram OGCModSpec {

requirements: Requirement[1..*] {
definition {
Requirements classes that this requirements module contains.
Requirements classes, recommendations, and permissions that this requirements module contains.
}
}
}
Expand Down
13 changes: 13 additions & 0 deletions sources/ogc-modspec-policy/00-forward.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[.preface]
== Foreword

This OGC ModSpec Policy specifies requirements and guidance for using the ModSpec as the formal structure for all OGC standards documents.

_Attention is drawn to the possibility that some of the elements of this document may
be the subject of patent rights. The Open Geospatial Consortium Inc. shall not be
held responsible for identifying any or all such patent rights._

_Recipients of this document are requested to submit, with their comments,
notification of any relevant patent claims or other intellectual property rights of
which they may be aware that might be infringed by any implementation of the standard
set forth in this document, and to provide supporting documentation._
42 changes: 42 additions & 0 deletions sources/ogc-modspec-policy/00-preface.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
[.preface]
== Preface

This OGC member Policy mandates the use if the ModSpec a model and related requirements and recommendations for writing and structuring modular OGC standards Further, this Policy mandates that every OGC Implementation Standard will provide an ABstract Test Suite (confomrance suite) designed to enable the consistent and verifiable testing of implementations of an OGC Standard that claim conformance.

The goal of this Policy is to ensure that a standard specifies requirements in a common and consistent manner and that these requirements are testable.

Suggested additions, changes, and comments on this this document are welcome and
encouraged. Such suggestions may be submitted through the OGC Change Request System
(http://www.opengeospatial.org/standards/cr) or by creating an issue in the GitHub repository for this document (https://github.com/opengeospatial/ogc-modspec).

[.preface]
== Document terms and definitions

This document uses the standard terms defined in Subclause 5.3 of [OGC 05-008], which
is based on the ISO/IEC Directives, Part 2. Rules for the structure and drafting of
International Standards. In particular, the word "shall" (not "must") is the
imperative verb form used to indicate a requirement to be strictly followed to
conform to this standard.

[.preface]
== Document editors

The following OGC Members participated in editing this document:

[%unnumbered]
|===
^h| Person ^h| Organization Represented
| Carl Reed | Carl Reed & Associates
|===

[.preface]
== Document Contributors

The following OGC Members contributed and particpated in developing Version 2 of the ModSpec.

[%unnumbered]
|===
^h| Person ^h| Organization Represented
| Chuck Heazel | Heazeltech
| Jeff Yutzler | ImageMatters
|===
17 changes: 17 additions & 0 deletions sources/ogc-modspec-policy/01-scope.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
== Scope
This OGC Policy Document defines the OGC Policy and Guidance related to the use of the ModSpec.

The ModSpec defines characteristics and structure for the specification of Standards
that will encourage implementation by minimizing difficulty determining
requirements, mimicking implementation structure and maximizing usability and
interoperability.

Part 1 of the ModSpec defines the requirements for using UML.
The use case is if the organizing mechanism for the data model
used in a standard is an object model, then the mapping from parts of the model to
the requirements classes should follow the logical mechanism described in Part 1 of the ModSpec.

Part 2 of the ModSpec defines the requirements for using XML. The XML related requirements classes
cover any standard which has as one of its purposes the introduction of a new XML schema.
Such a standard would normally define the schema, all of its components, and its intended uses.

6 changes: 6 additions & 0 deletions sources/ogc-modspec-policy/02-conformance.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[[cls-2]]
== Conformance

Conformance to the ModSpec by technical implementation standards
can be tested by inspection. The ModSpec test suite is specified in annex-A of the ModSpec.

22 changes: 22 additions & 0 deletions sources/ogc-modspec-policy/06-policy.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[[modspec-policy]]
== ModSpec Policy Requirements

The following requirement states that in OGC Standards development, the ModSpec model will be used.

[[req-01]]
[requirement,model=ogc,type="general"]
[width="90%",cols="2,6"]
|===
|*REQ001* | */req/policy/conformance-with-modspec* +
Any new OGC Standard, abstract specification that contains requirements, or major revision of an existing OGC Standard _SHALL_ comply with the requirements stated in the OGC ModSpec.
|===

Any OGC Standards document will specify the standardization goal.

[[req-02]]
[requirement,model=ogc,type="general"]
[width="90%",cols="2,6"]
|===
|*REQ002* | */req/policy/standardization-goal* +
Any new OGC Standard, abstract specification that contains requirements, or major revision of an existing OGC Standard _SHALL_ clearly state the stanrdization goal for the standard or abstract specification. This statement _SHOULD_ be in the `Abstract` or `Scope` clauses of the standard.
|===
29 changes: 29 additions & 0 deletions sources/ogc-modspec-policy/document.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
= The ModSpec Model OGC Policy
:doctype: draft policy
:docsubtype: logical-model
:status: Draft
:committee: technical
:docnumber: 24-xxx
:edition: 1.1.0
:received-date: 2025-01-01
:issued-date: xxxx-xx-xx
:published-date: xxxx-xx-xx
:copyright-year: 2024
:fullname: Carl Reed
:role: editor
:submitting-organizations: Carl Reed
:imagesdir: images
:mn-document-class: ogc
:mn-output-extensions: xml,html,doc,pdf,rxl
:local-cache-only:
:data-uri-image:

include::00-preface.adoc[]

include::00-foreword.adoc[]

include::01-scope.adoc[]

include::02-conformance.adoc[]

include::06-policy.adoc[]
22 changes: 1 addition & 21 deletions sources/part2/00-preface.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following OGC Members participated in editing this document:
|===
^h| Person ^h| Organization Represented
| Carl Reed | Carl Reed & Associates
| Chuck Heazel | Heazeltech
| John Herring | Oracle
|===

[.preface]
Expand All @@ -48,26 +48,6 @@ The following OGC Members contributed and particpated in developing Version 2 of
| Jeff Yutzler | ImageMatters
|===

[.preface]
== Acknowledgements

The following OGC Members were key contributors to Version 1 of the ModSpec

[%unnumbered]
|===
^h| Person ^h| Organization Represented
| Simon Cox | CSIRO
| David Danko | ESRI
| James Greenwood | SeiCorp, Inc.
| John R. Herring | Oracle USA
| Andreas Matheus | University of the Bundeswehr -- ITS
| Richard Pearsall | US National Geospatial-Intelligence Agency (NGA)
| Clemens Portele | interactive instruments GmbH
| Barry Reff | US Department of Homeland Security (DHS)
| Paul Scarponcini | Bentley Systems, Inc.
| Arliss Whiteside | BAE Systems - C3I Systems
|===

[.preface]
== Revision history

Expand Down
54 changes: 54 additions & 0 deletions sources/relaton/cache/iso/iso_19105_2022.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<bibdata type="standard" schema-version="v1.2.8">
<fetched>2024-12-17</fetched>
<title type="title-intro" format="text/plain" language="en" script="Latn">Geographic information</title>
<title type="title-main" format="text/plain" language="en" script="Latn">Conformance and testing</title>
<title type="main" format="text/plain" language="en" script="Latn">Geographic information - Conformance and testing</title>
<title type="title-intro" format="text/plain" language="fr" script="Latn">Information géographique</title>
<title type="title-main" format="text/plain" language="fr" script="Latn">Conformité et essais</title>
<title type="main" format="text/plain" language="fr" script="Latn">Information géographique - Conformité et essais</title>
<uri type="src">https://www.iso.org/standard/76457.html</uri>
<uri type="obp">https://www.iso.org/obp/ui/en/#!iso:std:76457:en</uri>
<uri type="rss">https://www.iso.org/contents/data/standard/07/64/76457.detail.rss</uri>
<docidentifier type="ISO" primary="true">ISO 19105:2022</docidentifier>
<docidentifier type="iso-reference">ISO 19105:2022(E)</docidentifier>
<docidentifier type="URN">urn:iso:std:iso:19105:stage-60.60</docidentifier>
<docnumber>19105</docnumber>
<date type="published">
<on>2022-07</on>
</date>
<contributor>
<role type="publisher"/>
<organization>
<name>International Organization for Standardization</name>
<abbreviation>ISO</abbreviation>
<uri>www.iso.org</uri>
</organization>
</contributor>
<edition>2</edition>
<language>en</language>
<language>fr</language>
<script>Latn</script>
<abstract format="text/plain" language="en" script="Latn">This document specifies the framework, concepts and methodology for conformance testing and criteria to be achieved to claim conformance to the family of applicable standardization documents regarding geographic information and relevant application domains. This document provides a framework for specifying abstract test suites composed of abstract test cases grouped in conformance classes and for defining the procedures to be followed during conformance testing.
Conformance can be claimed for data or software products or services or by specifications including any profile or functional standard. The structure of, and relationships between, conformance classes as defined in this document underly a systematic approach to configuration management involving managing dependencies within and between modules.</abstract>
<abstract format="text/plain" language="fr" script="Latn">Le présent document spécifie le cadre, les concepts et la méthodologie applicables aux tests et critères de conformité à respecter pour revendiquer la conformité avec la famille de document de normalisation sur l'information géographique et les domaines d'application concernés. Le présent document propose un cadre pour la spécification des suites de tests abstraits composées de cas de test abstraits regroupés en classes de conformité, et pour la définition des procédures à suivre lors des tests de conformité.
Il est possible de revendiquer la conformité pour les données ou les produits et services logiciels, ou par les spécifications, y compris de n'importe quel profil ou norme opératoire. La structure des classes de conformité définies dans le présent document, et les relations entre celles-ci, sous-tendent une approche systématique de la gestion de configuration qui implique la gestion des dépendances au sein des modules et entre ceux-ci.</abstract>
<status>
<stage>60</stage>
<substage>60</substage>
</status>
<copyright>
<from>2022</from>
<owner>
<organization>
<name>ISO</name>
</organization>
</owner>
</copyright>
<relation type="obsoletes">
<bibitem type="standard">
<formattedref format="text/plain">ISO 19105:2000</formattedref>
<docidentifier type="ISO" primary="true">ISO 19105:2000</docidentifier>
</bibitem>
</relation>
<place>Geneva</place>
</bibdata>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
not_found 2024-12-17
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
not_found 2024-12-17
3 changes: 1 addition & 2 deletions sources/sections/00-foreword.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[.preface]
== Foreword

The OGC ModSpec - A Standard for Designing and Writing Modular Standards specifies a formal structure for standards documents but does not supply
specific content. Where possible, this document is conformant with itself (with respect to the core conformance test class, <<cls-6>>
The OGC ModSpec - A Standard for Designing and Writing Modular Standards specifies a formal structure and requirements for writing modular standards documents. However, the ModSpec does not supply specific content. Where possible, this document is conformant with itself (with respect to the core conformance test class, <<cls-6>>
and the Conformance Test Suite <<annex-A-1>>).

_Attention is drawn to the possibility that some of the elements of this document may
Expand Down
32 changes: 5 additions & 27 deletions sources/sections/00-preface.adoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
[.preface]
== Preface

This OGC member developed and approved document defines a model and related requirements and recommendations for writing and structuring modular standards documents. Further, this model is designed to enable the consistent and verifiable testing of implementations of a standard that claim conformance.
This OGC member developed and approved document, referred to as the `ModSpec`, defines a model and related requirements and recommendations for writing and structuring modular standards documents. Further, this model is designed to enable the consistent and verifiable testing of implementations of a standard that claim conformance.

The goal is to ensure that a standard specifies requirements in a common and consistent manner and that these requirements are testable.

NOTE: For OGC only: Any new OGC Standard, abstract specification that contains requirements, or major revision of an existing OGC Standard shall comply with the requirements stated in this document.

NOTE: Historically, this document has been known and abbreviated as the "ModSpec". For continuity and ease of understanding this document may also be refered to as the "OGC ModSpec".

Suggested additions, changes, and comments on this this document are welcome and
encouraged. Such suggestions may be submitted through the OGC Change Request System
(http://www.opengeospatial.org/standards/cr) or by creating an issue in the GitHub repository for this document (https://github.com/opengeospatial/ogc-modspec).
(http://ogc.standardstracker.org/) or by creating an issue in the OGC ModSpec GitHub repository (https://github.com/opengeospatial/ogc-modspec).

[.preface]
== Document terms and definitions
Expand All @@ -20,7 +18,7 @@ This document uses the standard terms defined in Subclause 5.3 of [OGC 05-008],
is based on the ISO/IEC Directives, Part 2. Rules for the structure and drafting of
International Standards. In particular, the word "shall" (not "must") is the
imperative verb form used to indicate a requirement to be strictly followed to
conform to this standard.
conform to the ModSpec.

[.preface]
== Document editors
Expand All @@ -31,7 +29,7 @@ The following OGC Members participated in editing this document:
|===
^h| Person ^h| Organization Represented
| Carl Reed | Carl Reed & Associates
| Chuck Heazel | Heazeltech
| Chuck Heazel | Charles Heazel
|===

[.preface]
Expand All @@ -43,31 +41,11 @@ The following OGC Members contributed and particpated in developing Version 2 of
|===
^h| Person ^h| Organization Represented
| Simon Cox | CSIRO and OGC Fellow
| Chuck Heazel | Heazeltech
| Chuck Heazel | Charles Heazel
| Clemens Portele | interactive instruments GmbH
| Jeff Yutzler | ImageMatters
|===

[.preface]
== Acknowledgements

The following OGC Members were key contributors to Version 1 of the ModSpec

[%unnumbered]
|===
^h| Person ^h| Organization Represented
| Simon Cox | CSIRO
| David Danko | ESRI
| James Greenwood | SeiCorp, Inc.
| John R. Herring | Oracle USA
| Andreas Matheus | University of the Bundeswehr -- ITS
| Richard Pearsall | US National Geospatial-Intelligence Agency (NGA)
| Clemens Portele | interactive instruments GmbH
| Barry Reff | US Department of Homeland Security (DHS)
| Paul Scarponcini | Bentley Systems, Inc.
| Arliss Whiteside | BAE Systems - C3I Systems
|===

[.preface]
== Revision history

Expand Down
Loading
Loading