Skip to content

Commit

Permalink
adding release notes for CRS_WKT extension
Browse files Browse the repository at this point in the history
  • Loading branch information
jyutzler committed Sep 7, 2021
1 parent ee141fb commit a966798
Show file tree
Hide file tree
Showing 42 changed files with 2,417 additions and 300 deletions.
201 changes: 0 additions & 201 deletions spec/crs_wkt/LICENSE

This file was deleted.

24 changes: 18 additions & 6 deletions spec/crs_wkt/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
# Standard template

This GitHub repository contains the content for an OGC Standard.
## Content

The repo is organized as follows:
This folder contains the text for the standard

* index.adoc - nothing in this document
* standard - the main Standard document content
- organized in multiple sections and directories
- this is the only part needed to create a Standard
* standard_document.adoc - the main standard document with references to all sections
* remaining adocs - each section of the standard document is in a separate document: follow directions in each document to populate
* figures - figures go here
* images - Image files for graphics go here. Image files for figures go in the "figures" directory. Only place in here images not used in figures (e.g., as parts of tables, as logos, etc.)
* requirements - directory for requirements and requirement classes to be referenced in clause_7_normative_text.adoc
* code - sample code to accompany the standard, if desired
* abstract_tests - the Abstract Test Suite comprising one test for every requirement, optional
* UML - UML diagrams, if applicable

## Building

To produce the HTML of the standard run `asciidoctor --safe -a data-uri -o
standard_document.html standard_document.adoc`.

To produce the PDF of the standard run `asciidoctor-pdf --safe -o
standard_document.pdf standard_document.adoc`
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
[big]*i. Abstract*

The GeoPackage CRS WKT Extension defines how to encode coordinate reference systems in GeoPackage using the CRS WKT2 standard.
The core (unextended) GeoPackage Encoding Standard supports the older CRS WKT standard.
Through this extension, both encodings may be used.
However, use of the newer encoding is strongly encouraged.
GeoPackage clients are expected to use the newer encoding if both encodings are present.
This document is a revision to the GeoPackage WKT for Coordinate Reference Systems Extension that is currently published as Annex F.10 of GeoPackage Encoding Standard 1.3.0 (OGC 12-128r17).
This document is designed to replace that annex.
The extension defines how to encode coordinate reference systems in GeoPackage using the CRS WKT2 standard.
This revision adds coordinate epochs to the encoding of coordinate reference systems in a GeoPackage.

[big]*ii. Keywords*

Expand All @@ -18,6 +17,10 @@ The OGC GeoPackage Encoding Standard was adopted prior to the adoption of "12-06
As a result, the OGC GeoPackage Encoding Standard references an older document (link:http://portal.opengeospatial.org/files/?artifact_id=999[OpenGIS® 01-009 Implementation Specification: Coordinate Transformation Services Revision 1.0]) which has known ambiguities that are being encountered in the field.
This extension establishes a new column in `gpkg_spatial_ref_sys` to contain values that conform to the new standard.
In 2019, OGC adopted "18-010r7 OGC Well known text representation of Coordinate Reference Systems" as a revision to 12-063r5.
The core (unextended) GeoPackage Encoding Standard supports the older CRS WKT standard.
Through this extension, both encodings may be used.
However, use of the newer encoding is strongly encouraged.
GeoPackage clients are expected to use the newer encoding if both encodings are present.

In a dynamic CRS, coordinates of a point on the surface of the Earth may change with time.
To be unambiguous, the coordinates must always be qualified with the epoch at which they are valid.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 0 additions & 3 deletions spec/crs_wkt/index.adoc

This file was deleted.

2 changes: 2 additions & 0 deletions spec/crs_wkt/release_notes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Release Notes template
This is an AsciiDoc version of the release notes for an OGC Standard.
5 changes: 5 additions & 0 deletions spec/crs_wkt/release_notes/annex-bibliography.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[appendix]
[[Bibliography]]
= Bibliography

//list any non-normative references present in these Release Notes, but do not provide a list of new references from the revised standard.
9 changes: 9 additions & 0 deletions spec/crs_wkt/release_notes/annex-history.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[appendix]
= Revision History

.Revision History
[width="90%",options="header"]
|====================
|Date |Release |Editor | Primary clauses modified |Descriptions
| | | |
|====================
12 changes: 12 additions & 0 deletions spec/crs_wkt/release_notes/clause-0-preface.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Standard.[big]*Preface*

This document provides the set of revision notes for the GeoPackage WKT for Coordinate Reference Systems Extension 1.1.0 and does not modify that Standard.

This document provides the details of edits, deficiency corrections, and enhancements of the above-referenced Standard. It also documents those items that have been deprecated. Finally, this document provides implementations details related to issues of backwards compatibility.

_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 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._

.[big]*Keywords*
ogcdoc,
19 changes: 19 additions & 0 deletions spec/crs_wkt/release_notes/clause-1-intro.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
== Introduction

=== Scope

The GeoPackage WKT for Coordinate Reference Systems Extension 1.1.0 (OGC 21-057) is a revision to the GeoPackage extension that is currently published as Annex F.10 of GeoPackage Encoding Standard 1.3.0 (OGC 12-128r17).
The new document is designed to replace that annex.
The extension defines how to encode coordinate reference systems in GeoPackage using the CRS WKT2 standard.
This revision adds coordinate epochs to the encoding of coordinate reference systems in a GeoPackage.

=== Document contributor contact points

All questions regarding this document should be directed to the contacts provided below or the referenced Standard editor(s).

.Contacts
[width="80%",options="header"]
|====================
|Name |Organization
|<name> | <organization>
|====================
8 changes: 8 additions & 0 deletions spec/crs_wkt/release_notes/clause-2-references.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[[references]]
== References

The following normative documents are new or updated references in the Standard to which these Release Notes apply.

OGC: OGC 12-128r17 OGC GeoPackage Encoding Standard 1.3.0, http://www.geopackage.org/spec130/ (2020)

OGC: OGC 21-057 OGC GeoPackage CRS for Coordinate Reference Systems Extension 1.1 (TBD)
18 changes: 18 additions & 0 deletions spec/crs_wkt/release_notes/clause-3-terms.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
== Terms and definitions

This document uses the terms defined in Sub-clause 5.3 of [OGC 06-121r8], 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 verb form used to indicate a requirement to be strictly followed to conform to this Standard.

For the purposes of this document, the following additional terms and definitions apply.

=== administrative change
An administrative change is a change that does not alter the conformance abstract tests for any requirements. It includes typographical errors, changes in wording to improve clarity or consistency, and perfunctory changes such as changes in version numbers.

=== critical Change
A critical change is a change that alters requirements in a way that is known to cause reverse compatibility issues.

=== substantive change
A substantive change is a change that alters requirements in a way that is not deemed to have a high risk for causing reverse compatibility issues.

=== Abbreviated terms

//List any abbreviations and their full expansions that are used in this document
Loading

0 comments on commit a966798

Please sign in to comment.