You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2021/10/06 16:07:38 UTC
[sis-site] branch main updated (21538a1 -> 0cced94)
This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/sis-site.git.
from 21538a1 Upgrade web site to Bootstrap 5. Remove obsolete material. Use shorter abbreviations for ISO/OGC/JDBC/UTC.
new 993bef3 Set the sidebar at a fixed position.
new 7d024e8 Move DOAP.rdf file and templates as static resources, for automatic inclusion in the web site (they were previously copied manually).
new 0cced94 Review of page content for SIS 1.1.
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
layouts/_default/baseof.html | 5 +-
layouts/partials/menu.html | 2 +-
layouts/shortcodes/CRS.html | 2 +-
layouts/shortcodes/GML.html | 1 +
layouts/shortcodes/GPS.html | 1 +
layouts/shortcodes/ISO.html | 2 +-
layouts/shortcodes/JDBC.html | 2 +-
layouts/shortcodes/OGC.html | 2 +-
layouts/shortcodes/SIS.html | 1 +
layouts/shortcodes/SQL.html | 1 +
layouts/shortcodes/UTC.html | 2 +-
layouts/shortcodes/WKT.html | 1 +
layouts/shortcodes/XML.html | 1 +
layouts/shortcodes/version.html | 1 +
source/_index.md | 100 +++++++++--------
source/build.md | 42 +++++---
source/code-patterns.md | 22 ++--
source/coding-conventions.md | 35 +++---
source/command-line.md | 118 ++++++++++-----------
source/contributor.md | 42 ++++----
source/downloads.md | 53 ++++-----
source/epsg.md | 46 ++++----
source/faq.md | 96 +++++++++--------
source/faq_fr.md | 74 ++++++-------
source/mail-lists.md | 56 ++++++----
source/release-management.md | 6 +-
source/source.md | 42 ++++----
DOAP.rdf => static/DOAP.rdf | 0
static/css/sis.css | 4 +
.../templates}/release-announce.html | 0
.../templates}/release-discuss.txt | 0
{templates => static/templates}/release-vote.txt | 0
32 files changed, 391 insertions(+), 369 deletions(-)
create mode 100644 layouts/shortcodes/GML.html
create mode 100644 layouts/shortcodes/GPS.html
create mode 100644 layouts/shortcodes/SIS.html
create mode 100644 layouts/shortcodes/SQL.html
create mode 100644 layouts/shortcodes/WKT.html
create mode 100644 layouts/shortcodes/XML.html
create mode 100644 layouts/shortcodes/version.html
rename DOAP.rdf => static/DOAP.rdf (100%)
rename {templates => static/templates}/release-announce.html (100%)
rename {templates => static/templates}/release-discuss.txt (100%)
rename {templates => static/templates}/release-vote.txt (100%)
[sis-site] 03/03: Review of page content for SIS 1.1.
Posted by de...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sis-site.git
commit 0cced9458354cbcdb492c935ac685aed6d32fd48
Author: Martin Desruisseaux <ma...@geomatys.com>
AuthorDate: Wed Oct 6 17:58:26 2021 +0200
Review of page content for SIS 1.1.
---
layouts/partials/menu.html | 2 +-
layouts/shortcodes/CRS.html | 2 +-
layouts/shortcodes/GML.html | 1 +
layouts/shortcodes/GPS.html | 1 +
layouts/shortcodes/ISO.html | 2 +-
layouts/shortcodes/JDBC.html | 2 +-
layouts/shortcodes/OGC.html | 2 +-
layouts/shortcodes/SIS.html | 1 +
layouts/shortcodes/SQL.html | 1 +
layouts/shortcodes/UTC.html | 2 +-
layouts/shortcodes/WKT.html | 1 +
layouts/shortcodes/XML.html | 1 +
layouts/shortcodes/version.html | 1 +
source/_index.md | 100 ++++++++++++++++++----------------
source/build.md | 42 ++++++++------
source/code-patterns.md | 22 ++++----
source/coding-conventions.md | 35 ++++++------
source/command-line.md | 118 ++++++++++++++++++----------------------
source/contributor.md | 42 +++++++-------
source/downloads.md | 53 +++++++-----------
source/epsg.md | 46 ++++++++--------
source/faq.md | 96 ++++++++++++++++----------------
source/faq_fr.md | 74 +++++++++++++------------
source/mail-lists.md | 56 +++++++++++--------
source/release-management.md | 6 +-
source/source.md | 42 +++++++-------
static/css/sis.css | 4 ++
27 files changed, 389 insertions(+), 366 deletions(-)
diff --git a/layouts/partials/menu.html b/layouts/partials/menu.html
index 86d7641..c1071dd 100644
--- a/layouts/partials/menu.html
+++ b/layouts/partials/menu.html
@@ -28,7 +28,6 @@
<li><a class="dropdown-item" href="tables/CoordinateOperationMethods.html">Map Projections</a></li>
<li><a class="dropdown-item" href="code-patterns.html">Code Patterns</a></li>
<li><a class="dropdown-item" href="faq.html">FAQ</a></li>
- <li><a class="dropdown-item" href="https://cwiki.apache.org/confluence/display/SIS">Wiki</a></li>
</ul>
</li>
<li class="nav-item dropdown">
@@ -38,6 +37,7 @@
<li><a class="dropdown-item" href="coding-conventions.html">Coding Conventions.</a></li>
<li><a class="dropdown-item" href="https://issues.apache.org/jira/browse/SIS">Issue Tracker</a></li>
<li><a class="dropdown-item" href="release-management.html">Release management</a></li>
+ <li><a class="dropdown-item" href="https://cwiki.apache.org/confluence/display/SIS">Wiki</a></li>
</ul>
</li>
<li class="nav-item dropdown">
diff --git a/layouts/shortcodes/CRS.html b/layouts/shortcodes/CRS.html
index e4371f7..b6f1023 100644
--- a/layouts/shortcodes/CRS.html
+++ b/layouts/shortcodes/CRS.html
@@ -1 +1 @@
-<abbr title="Coordinate Reference System">CRS</abbr>
+<abbr title="Coordinate Reference System">CRS</abbr>
\ No newline at end of file
diff --git a/layouts/shortcodes/GML.html b/layouts/shortcodes/GML.html
new file mode 100644
index 0000000..e4a1323
--- /dev/null
+++ b/layouts/shortcodes/GML.html
@@ -0,0 +1 @@
+<abbr title="Geographic Markup Language">GML</abbr>
\ No newline at end of file
diff --git a/layouts/shortcodes/GPS.html b/layouts/shortcodes/GPS.html
new file mode 100644
index 0000000..0650002
--- /dev/null
+++ b/layouts/shortcodes/GPS.html
@@ -0,0 +1 @@
+<abbr title="Global Positioning System">GPS</abbr>
\ No newline at end of file
diff --git a/layouts/shortcodes/ISO.html b/layouts/shortcodes/ISO.html
index 1967b63..6c60804 100644
--- a/layouts/shortcodes/ISO.html
+++ b/layouts/shortcodes/ISO.html
@@ -1 +1 @@
-<abbr title="International Organization for Standardization">ISO</abbr>
+<abbr title="International Organization for Standardization">ISO</abbr>
\ No newline at end of file
diff --git a/layouts/shortcodes/JDBC.html b/layouts/shortcodes/JDBC.html
index a6f6b18..c838d09 100644
--- a/layouts/shortcodes/JDBC.html
+++ b/layouts/shortcodes/JDBC.html
@@ -1 +1 @@
-<abbr title="Java DataBase Connectivity">JDBC</abbr>
+<abbr title="Java DataBase Connectivity">JDBC</abbr>
\ No newline at end of file
diff --git a/layouts/shortcodes/OGC.html b/layouts/shortcodes/OGC.html
index 3e7a6b6..6fa21be 100644
--- a/layouts/shortcodes/OGC.html
+++ b/layouts/shortcodes/OGC.html
@@ -1 +1 @@
-<abbr title="Open Geospatial Consortium">OGC</abbr>
+<abbr title="Open Geospatial Consortium">OGC</abbr>
\ No newline at end of file
diff --git a/layouts/shortcodes/SIS.html b/layouts/shortcodes/SIS.html
new file mode 100644
index 0000000..f497c8b
--- /dev/null
+++ b/layouts/shortcodes/SIS.html
@@ -0,0 +1 @@
+<abbr title="Spatial Information System">SIS</abbr>
\ No newline at end of file
diff --git a/layouts/shortcodes/SQL.html b/layouts/shortcodes/SQL.html
new file mode 100644
index 0000000..e1e06ab
--- /dev/null
+++ b/layouts/shortcodes/SQL.html
@@ -0,0 +1 @@
+<abbr title="Structured Query Language">SQL</abbr>
\ No newline at end of file
diff --git a/layouts/shortcodes/UTC.html b/layouts/shortcodes/UTC.html
index 6796cf3..c7761f3 100644
--- a/layouts/shortcodes/UTC.html
+++ b/layouts/shortcodes/UTC.html
@@ -1 +1 @@
-<abbr title="Universal Time Coordinated">UTC</abbr>
+<abbr title="Universal Time Coordinated">UTC</abbr>
\ No newline at end of file
diff --git a/layouts/shortcodes/WKT.html b/layouts/shortcodes/WKT.html
new file mode 100644
index 0000000..a4c8e63
--- /dev/null
+++ b/layouts/shortcodes/WKT.html
@@ -0,0 +1 @@
+<abbr title="Well Known Text">WKT</abbr>
\ No newline at end of file
diff --git a/layouts/shortcodes/XML.html b/layouts/shortcodes/XML.html
new file mode 100644
index 0000000..f610c26
--- /dev/null
+++ b/layouts/shortcodes/XML.html
@@ -0,0 +1 @@
+<abbr title="Extensible Markup Language">XML</abbr>
\ No newline at end of file
diff --git a/layouts/shortcodes/version.html b/layouts/shortcodes/version.html
new file mode 100644
index 0000000..b123147
--- /dev/null
+++ b/layouts/shortcodes/version.html
@@ -0,0 +1 @@
+1.1
\ No newline at end of file
diff --git a/source/_index.md b/source/_index.md
index f262e80..d2c4194 100644
--- a/source/_index.md
+++ b/source/_index.md
@@ -6,68 +6,74 @@ Apache Spatial Information System (SIS) is a free software, Java language librar
SIS provides data structures for geographic features and associated metadata along with methods to manipulate those data structures.
The library is an implementation of [GeoAPI 3.0.1][geoapi] interfaces and can be used for desktop or server applications.
-The SIS metadata module forms the base of the library and enables the creation of metadata objects which comply with the model of OGC/ISO international standards.
-The SIS referencing module enable the construction of geodetic data structures for geospatial referencing such as axis, projection and coordinate reference system definitions,
+The SIS metadata module forms the base of the library and enables the creation of metadata objects
+which comply with the model of {{% OGC %}}/{{% ISO %}} international standards.
+The SIS referencing module enable the construction of geodetic data structures for geospatial referencing
+such as axis, projection and coordinate reference system definitions,
along with the associated operations which enable the transformation of coordinates between different systems of reference.
The SIS storage modules provide a common approach to the reading and writing of metadata, features and coverages
applicable to simple imagery as to many dimensional data structures.
+SIS provides processing functions such as multi-threaded rasters reprojection and isolines computation from raster data.
-Some Apache SIS features are:
+<details open>
+ <summary>
+ Some international standards and other features supported by Apache {{% SIS %}} are:
+ </summary>
-* Geographic metadata (ISO 19115-1:2014)
- * Read from or written to ISO 19115-3:2016 (current standard) or ISO 19139:2007 (older standard) compliant XML documents.
- * Read from netCDF, GeoTIFF, Landsat, GPX and Moving Feature CSV encoding.
+* Raster formats:
+ * Read NetCDF-3 Classic and 64-bit Offset Format ([OGC 10-092][netCDF]).
+ * Read GeoTIFF ([OGC 19-008][geoTIFF]) including BigTIFF extension.
+ * Read Landsat (groups of GeoTIFF files).
+* Feature formats:
+ * Read Moving Feature Comma Separated Values (CSV) encoding ([OGC 14-084][MF_CSV]).
+ * Read Moving Feature netCDF encoding ([OGC 16-114][netCDF_MF]).
+ * Read GPX (a {{% XML %}} schema for {{% GPS %}} data).
+ * Read features from {{% SQL %}} spatial databases by analysing the database schema.
+* Geographic metadata (ISO 19115-1:2014):
+ * Read ISO 19115 metadata from all above-listed raster and feature formats.
+ * Read and write XML documents compliant with ISO 19115-3:2016 (current standard) or ISO 19139:2007 (older standard).
* Automatic conversions between the metadata model published in 2003 and the revision published in 2014.
-* Referencing by coordinates (ISO 19111:2007)
- * Well Known Text (WKT) version 1 and 2 (ISO 19162:2015).
- * Geographic Markup Language (GML) version 3.2 (ISO 19136:2007).
- * [EPSG geodetic dataset](epsg.html) for geodetic definitions and for coordinate operations.
- See the list of [supported coordinate reference systems](tables/CoordinateReferenceSystems.html).
- * Mercator, Transverse Mercator, Lambert Conic Conformal, stereographic and more map projections.
- See the list of [supported operation methods](tables/CoordinateOperationMethods.html).
-* Referencing by identifiers (ISO 19112:2003)
+* Units of measurement:
+ * Implementation of [JSR-363][JSR_363]
+ with parsing, formating and unit conversion functionalities.
+ * The same implementation is available as a [small standalone separated project][seshat].
+* Referencing by coordinates (ISO 19111:2007):
+ * Read and write Well Known Text (WKT) version 1 and 2 (ISO 19162:2015).
+ * Read and write Geographic Markup Language (GML) version 3.2 (ISO 19136:2007).
+ * Use [EPSG geodetic dataset](epsg.html) for geodetic definitions and for coordinate operations.
+ * More than 6000 [supported coordinate reference systems](tables/CoordinateReferenceSystems.html).
+ * Mercator, Transverse Mercator, Lambert Conic Conformal, stereographic
+ and more [supported operation methods](tables/CoordinateOperationMethods.html).
+* Referencing by identifiers (ISO 19112:2003):
* Geohashes (a simple encoding of geographic coordinates into short strings of letters and digits).
* Military Grid Reference System (MGRS), also used for some civilian uses.
-* Units of measurement
- * Implementation of [JSR-363](https://www.jcp.org/aboutJava/communityprocess/final/jsr363/index.html)
- with parsing, formating and unit conversion functionalities.
+* Processing:
+ * Multi-threaded raster reprojection.
+ * Multi-threaded isolines computation from raster data.
+ * Filtering of features (ISO 19143:2010 conceptual model).
+</details>
-## Using Apache SIS {#user}
-The latest SIS release is 1.1, released November 2021.
-Apache SIS requires Java 10 or higher for building, but can be executed on Java 8 or higher.
-If using Java 8 Runtime Environment, nothing else is needed since Java 8 includes JAXB.
-If using Java 9 or higher, one of the following configurations is needed
-(those extra configurations are temporary until support for Java 8 will be dropped in a future SIS version):
-* "`--add-modules java.xml.bind,java.xml.ws.annotation`" option (available with Java 9 or 10 only) added to the `java` command
-* or JAXB dependency added from Glassfish or Jakarata projects. See [Maven coordinates](downloads.html#maven).
+## Using Apache SIS {#user}
+The latest SIS release is {{% version %}}, released November 2021,
+and can be [downloaded](downloads.html) as a `zip` files or as Maven dependencies.
+Apache {{% SIS %}} requires Java 17 or higher for [building](build.html), but can be executed on Java 8 or higher.
The EPSG geodetic dataset is optional for licensing reasons, but recommended.
EPSG database installation is [described in a separated page](epsg.html).
-Apache SIS is a Java library for use by other applications.
+Apache {{% SIS %}} is a Java library for use by other applications.
Leveraging the full SIS capabilities or getting the best performance require that users write their own applications on top of SIS.
-However a command-line tool is provided for allowing users to experiment some SIS functionalities before writing code.
-
-* [Downloads](downloads.html) as a `zip` files or as Maven dependencies.
-* [Developer guide](book/index.html) — note that this is work in progress.
-* [Online Javadoc](apidocs/index.html) for API documentation.
-* [Command-line interface](command-line.html) for an overview of the command-line tool.
-* [Recommended code patterns](code-patterns.html) for writing more robust applications with Apache SIS.
-
-## Developing Apache SIS {#developer}
-
-Following links are for those who wish to contribute to Apache SIS:
+The [developer guide](book/index.html), [online Javadoc](apidocs/index.html) and [recommended code patterns](code-patterns.html) page
+provide instructions about developing with SIS.
+However a [command-line tool](command-line.html) is also provided for allowing users to experiment some SIS functionalities before writing code.
-* [New contributor](contributor.html): background knowledge.
-* [Source code](source.html): fetching the code, choosing a branch, opening in an IDE.
-* [Coding conventions](coding-conventions.html): source code formatting.
-* [Build](build.html): build from the source, create the distribution file.
-* [Issue tracking][JIRA]: JIRA.
-* [Release management](release-management.html) (for release managers)
-* [SIS Wiki][wiki] for "drawing board" and roadmap.
-[geoapi]: http://www.geoapi.org/
-[wiki]: http://cwiki.apache.org/confluence/display/SIS
-[JIRA]: http://issues.apache.org/jira/browse/SIS
+[geoapi]: http://www.geoapi.org/
+[netCDF]: https://portal.ogc.org/files/?artifact_id=43734
+[netCDF_MF]: http://docs.opengeospatial.org/bp/16-114r3/16-114r3.html
+[geoTIFF]: http://docs.opengeospatial.org/is/19-008r4/19-008r4.html
+[MF_CSV]: http://docs.opengeospatial.org/is/14-084r2/14-084r2.html
+[JSR_363]: https://www.jcp.org/aboutJava/communityprocess/final/jsr363/index.html
+[seshat]: https://unitsofmeasurement.github.io/seshat/
diff --git a/source/build.md b/source/build.md
index 8f56cd7..ef607e6 100644
--- a/source/build.md
+++ b/source/build.md
@@ -2,7 +2,7 @@
title: Build from source
---
-Apache SIS is built by Maven.
+Apache {{% SIS %}} is built by Maven.
For installing the JAR files in the local Maven repository, execute the following command
from the SIS project root:
@@ -10,6 +10,16 @@ from the SIS project root:
mvn install
{{< / highlight >}}
+The JavaFX application is excluded by default because it depends on
+the [JavaFX platform][JavaFX] which is distributed under GPL license
+(note that the SIS module stay under Apache 2 licence).
+Likewise the [EPSG geodetic dataset](epsg.html) is excluded by default for licensing reasons.
+For including the JavaFX module and the use of EPSG dataset in the build:
+
+{{< highlight bash >}}
+mvn install --activate-profiles javafx,non-free
+{{< / highlight >}}
+
For signing the artifacts and producing distribution files (`apache-sis-bin.zip` and `apache-sis.oxt`),
execute the following command.
Note that it requires an OpenPGP (_Open Pretty Good Privacy_) software for cryptography signatures
@@ -27,8 +37,8 @@ The remaining of this page provides more advanced tips for SIS developers.
The distribution archive is a file with the `.zip` extension containing most SIS modules except `sis-webapp`
(because Web applications use an other packaging) together with their dependencies.
-However for users convenience, we provide a shell script launching the SIS command line tool.
-That shell script, together with other files (`README`, `LICENSE`, <i>etc.</i>) are bundled in a ZIP file created as below:
+However for users convenience, we provide shell scripts launching the SIS command line tool or the JavaFX application.
+Those shell scripts, together with other files (`README`, `LICENSE`, <i>etc.</i>) are bundled in a ZIP file created as below:
{{< highlight bash >}}
cd application/sis-console
@@ -37,32 +47,29 @@ mvn package org.apache.sis.core:sis-build-helper:dist
This task is executed automatically if the `apache-release` profile is activated at build time.
Above command is for the cases where the developer wants the distribution file without rebuilding the whole project.
-Optionally, the Apache SIS version can be inserted as a 4th element between `sis-build-helper:` and `:dist`
-if there is many versions of the plugin in the local repository.
-
-The result will be created in the `target/distribution/apache-sis-<version>.zip` file.
-To test, uncompress in any directory and execute `apache-sis-<version>/bin/sis`.
+The result will be created in the `target/distribution/apache-sis-<version>.zip` file.
+To test, uncompress in any directory and execute `apache-sis-<version>/bin/sis`.
## Known limitations {#limitations}
The current plugin implementation has some hard-coded values, especially:
-* The ZIP file content is copied from the `application/sis-console/src/main/artifact` directory.
-* The final filename is hard-coded to `apache-sis-<version>.zip`.
+* The ZIP file content is copied from the `application/sis-console/src/main/artifact` directory.
+* The final filename is hard-coded to `apache-sis-<version>.zip`.
# SIS-specific Maven plugin {#build-helper}
-Apache SIS uses a `sis-build-helper` plugin for SIS-specific tasks and Javadoc customization.
+Apache {{% SIS %}} uses a `sis-build-helper` plugin for SIS-specific tasks and Javadoc customization.
This plugin is used automatically by `mvn install`. Consequently the remaining of this page
can be safely ignored. This page is provided only as a reference for developers wanting to
take a closer look to SIS `pom.xml` file.
## Localized resources compiler {#resources}
-Localized resources are provided in `*.properties` files as specified by the `java.util.PropertyResourceBundle` standard class.
+Localized resources are provided in `*.properties` files as specified by the `java.util.PropertyResourceBundle` standard class.
However SIS does not use those resources files directly. Instead `*.properties` files are transformed into binary files having
the same filename but the `.utf` extension. This conversion is done for efficiency, for convenience (the compiler applies the
-`java.text.MessageFormat` _doubled single quotes_ rule itself), and for compile-time safety.
+`java.text.MessageFormat` _doubled single quotes_ rule itself), and for compile-time safety.
In addition to generating the `*.utf` files, the resource compiler may modify the `*.java` files having the same name than the
resource files. For example given a set of `Vocabulary*.properties` files (one for each supported language), the compiler will
@@ -103,15 +110,15 @@ mvn org.apache.sis.core:sis-build-helper:compile-resources
## JAR files collector {#jar-collect}
-Links or lists all JAR files (including dependencies) in the `target/binaries` directory of the parent project.
+Links or lists all JAR files (including dependencies) in the `target/binaries` directory of the parent project.
This plugin performs a work similar to the standard Maven assembly plugin work, with the following differences:
* In multi-modules projects, this plugin does not create anything in the `target` directory of sub-modules.
- Instead, this plugin groups everything in the `target/binaries` directory of the parent module.
+ Instead, this plugin groups everything in the `target/binaries` directory of the parent module.
* This plugin does not create any ZIP file. It only links or lists JAR files.
This plugin uses hard links on platforms that support them,
so execution of this plugin should be very cheap and consume few disk space.
-* Dependencies already present in the `target/binaries` directory are presumed stables and
+* Dependencies already present in the `target/binaries` directory are presumed stables and
are not overwritten. Only artifacts produced by the Maven build are unconditionally overwritten.
This plugin can be activated by the following fragment in the parent `pom.xml` file:
@@ -134,3 +141,6 @@ This plugin can be activated by the following fragment in the parent `pom.xml` f
</plugins>
</build>
{{< / highlight >}}
+
+
+[JavaFX]: https://openjfx.io/
diff --git a/source/code-patterns.md b/source/code-patterns.md
index ce26706..ebe649d 100644
--- a/source/code-patterns.md
+++ b/source/code-patterns.md
@@ -2,7 +2,7 @@
title: Recommended code patterns
---
-This page lists some recommended code pattern for developing or using Apache SIS.
+This page lists some recommended code pattern for developing or using Apache {{% SIS %}}.
{{< toc >}}
@@ -10,14 +10,14 @@ This page lists some recommended code pattern for developing or using Apache SIS
Recommended code pattern when using the `sis-referencing` module.
-## Never explicitely swap ordinates for axis order {#axisOrder}
+## Never explicitely swap coordinates for axis order {#axisOrder}
The [axis order issue](faq.html#axisOrder) causes lot of confusion,
-and developers are sometime tempted to swap their ordinate values in order to comply with some expected axis ordering.
-It should never be necessary, since the Apache SIS referencing engine manages axis order transparently — provided that
-the Coordinate Reference System (CRS) definition is accurate.
-If a code needs to swap ordinates, this is probably an indication that the {{% CRS %}} has not been properly defined.
-Instead than patching the coordinate values, try to make sure that the _Source CRS_ (associated to the original data)
+and developers are sometime tempted to swap their coordinate values in order to comply with some expected axis ordering.
+It should never be necessary, since the Apache {{% SIS %}} referencing engine manages axis order transparently —
+provided that the Coordinate Reference System (CRS) definition is accurate.
+If a code needs to swap coordinates, this is probably an indication that the {{% CRS %}} has not been properly defined.
+Instead of patching the coordinate values, try to make sure that the _Source CRS_ (associated to the original data)
and the _Target CRS_ (the coordinate space where to perform the work) are properly defined,
and let the referencing engine performs the conversion from the source to the target {{% CRS %}}.
@@ -32,7 +32,7 @@ This approach may be ambiguous as it does not specify whether the (<var>x</var>,
(see the [axis order issue](faq.html#axisOrder)) or if the <var>y</var> axis is oriented downward.
All images in SIS shall be georeferenced by at least an affine transform (more complex transforms are also possible),
never by a rectangle or bounding box.
-In the two-dimensional case, the standard `java.awt.geom.AffineTransform` class can be used.
+In the two-dimensional case, the standard `java.awt.geom.AffineTransform` class can be used.
# International {#international}
@@ -43,12 +43,12 @@ Recommended code pattern for internationalization.
Geospatial data often cover a wide geographic area, spanning many time zones.
Timezone are sometime specified as metadata in the header of data files to be read,
or is sometime fixed to {{% UTC %}} by applications managing world-wide data.
-Some Apache SIS objects have `Locale` and `TimeZone` information.
+Some Apache {{% SIS %}} objects have `Locale` and `TimeZone` information.
Such locale and timezone are given to `java.text.DateFormat` or `java.util.Calendar` constructors among others.
When reading dates or timestamps from a {{% JDBC %}} database,
always use the `ResultSet` method accepting a `Calendar` argument, when such method is available.
-For example prefer the `getTimestamp(int, Calendar)` method instead than `getTimestamp(int)`.
+For example prefer the `getTimestamp(int, Calendar)` method instead of `getTimestamp(int)`.
The `Calendar` object should has been created with the appropriate timezone.
## Replace underscores by spaces before sorting {#sort}
@@ -77,7 +77,7 @@ for (int i=0; i<string.length();) {
# Logging {#logging}
-Apache SIS uses the `java.util.logging` framework, but with a [mechanism allowing users to redirect
+Apache {{% SIS %}} uses the `java.util.logging` framework, but with a [mechanism allowing users to redirect
to another framework](http://sis.apache.org/apidocs/org/apache/sis/util/logging/LoggerFactory.html).
The logger names are usually the package name of the class emitting log messages, but not necessarily.
In particular, we do not follow this convention if the class is located in an internal package
diff --git a/source/coding-conventions.md b/source/coding-conventions.md
index 9a61a82..fc43011 100644
--- a/source/coding-conventions.md
+++ b/source/coding-conventions.md
@@ -2,7 +2,7 @@
title: Source code
---
-This page describes some coding conventions applied in Apache SIS development.
+This page describes some coding conventions applied in Apache {{% SIS %}} development.
{{< toc >}}
@@ -28,25 +28,25 @@ Classes implementing GeoAPI interfaces usually (but not always) begin with `Abst
as opposed to other implementations specialized for a fixed number of dimensions or other conditions.
* Implementations specialized for a fixed number of dimensions are suffixed with `1D`, `2D`, `3D` or `4D` rather than being prefixed.
-Example: `GeneralEnvelope` class is an implementation of `Envelope` interface for the multi-dimensional case.
-`Envelope2D` is another implementation of the same interface specialized for the two-dimensional case.
+Example: the `GeneralEnvelope` class is an implementation of `Envelope` interface for the multi-dimensional case.
+The `Envelope2D` class is another implementation of the same interface specialized for the two-dimensional case.
## Internal packages {#internal}
All classes in `org.apache.sis.internal` sub-packages are for SIS usage only and may change without warning in any future release.
Those classes are excluded from Javadoc and will not be exported by SIS Jigsaw modules.
-Those packages may be renamed after SIS upgraded to JDK 9.
+Those packages may be renamed after SIS upgraded to JDK 9+.
## Substitution for non-existent classes {#substitutions}
-When using a JDK 9 class that does not exist on JDK 8, define a class of the same name in a
+When using a JDK 9+ class that does not exist on JDK 8, define a class of the same name in a
`org.apache.sis.internal` sub-package with the minimal amount of needed functionalities,
provided that it can be done with reasonable effort.
Otherwise just delete the JDK9-dependent code from the development branch.
# Code formatting {#formatting}
-Apache SIS uses the standard Java conventions, except for the 80 characters line length restriction.
+Apache {{% SIS %}} uses the standard Java conventions, except for the 80 characters line length restriction.
The conventions listed below are guidelines. Some exceptions to those conventions can occur but should
be rare (see [exceptions to coding conventions](#tabular-formatting)).
@@ -75,7 +75,7 @@ import org.opengis.feature.Feature;
* **Indentation:** Use a consistent space indents and never use tabs.
+ Use 4 space indents for Java files.
- + Use 2 space indents for XML files, because {{% ISO %}}/{{% OGC %}} XML schemas tend to have a very deep structure.
+ + Use 2 space indents for XML files, because {{% ISO %}}/{{% OGC %}} {{% XML %}} schemas tend to have a very deep structure.
* **Space after keyword:** Put a space after `if`, `else`, `for`, `try`, `catch` and similar keywords
(not after method names).
* **Trailing Whitespaces:** Remove all trailing whitespaces.
@@ -119,7 +119,7 @@ Of course, tabular format shall not be abused.
# Documentation formatting {#javadoc}
-Apache SIS uses the standard Javadoc conventions, except for the 80 characters line length restriction.
+Apache {{% SIS %}} uses the standard Javadoc conventions, except for the 80 characters line length restriction.
Javadoc lines should not exceed 120 characters, but exceptions to this rule may exist for preserving the
structure of `<table>` elements.
@@ -149,7 +149,7 @@ For example:
* Instead of "`<code>✎</code>`", use "`{@code ✎}`".
* Instead of "`a < b < c`", use "`{@literal a < b < c}`".
* Instead of "`<pre>✎</pre>`" for a Java listing, use "`{@preformat java ✎}`"
- (this Javadoc tag is specific to Apache SIS — see above table).
+ (this Javadoc tag is specific to Apache {{% SIS %}} — see above table).
### Paragraphs {#paragraph}
@@ -164,11 +164,10 @@ In such cases, `<p>` shall have a matching `</p>` tag at the paragraph end in or
### Javadoc CSS {#css}
Avoid using HTML attributes other than `class` as much as possible.
-Instead, rely on styling. Some HTML tags having a style definition in Apache SIS are:
+Instead, rely on styling. Some HTML tags having a style definition in Apache {{% SIS %}} are:
HTML tag | Description
------------------------- | -------------------------------------------------------------------------------------------
-`<div class="section">` | Header of a sub-section in a package, class or member description.
`<div class="note">` | Indented text with smaller font, used for notes or examples.
`<div class="warning">` | Text in red color, used for warning about probable API changes.
`<ul>` and `<ol>` | Default list styles with few space between items (suitable for compact lists).
@@ -188,7 +187,7 @@ For examples of MathML usage in SIS, search for the `<math …>` XML tag in Java
(note: there is also legacy `{@preformat math …}` custom Javadoc tags, but they may be phased out as MathML adoption increase).
For an introduction to MathML, see:
-* [A Gentle Introduction to MathML][mathml-dessci] on Design Science
+* [MathML learn & use][mathml-W3C] on W3C
* [Working with MathML][mathml-wolfram] on Wolfram Mathematica
MathML is supported natively in Firefox, Safari and Opera.
@@ -197,9 +196,9 @@ Firefox users can optionally install the [fonts for Mozilla's MathML engine][mat
Note that a [JavaScript display engine][mathml-mathjax] is available for all browsers, but not yet used by SIS.
[srcheaders]: http://www.apache.org/legal/src-headers.html
-[JLS-order]: http://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html#jls-8.1.1
-[mathml-wolfram]: http://reference.wolfram.com/mathematica/XML/tutorial/MathML.html
-[mathml-dessci]: http://www.dessci.com/en/reference/mathml/
-[mathml-fonts]: http://developer.mozilla.org/en-US/docs/Mozilla/MathML_Project/Fonts
-[mathml-plugin-ie]: http://www.dessci.com/en/products/mathplayer/download.htm
-[mathml-mathjax]: http://www.mathjax.org/
+[JLS-order]: https://docs.oracle.com/javase/specs/jls/se8/html/jls-8.html#jls-8.1.1
+[mathml-W3C]: https://www.w3.org/Math/
+[mathml-wolfram]: https://reference.wolfram.com/language/XML/tutorial/MathML.html
+[mathml-fonts]: https://developer.mozilla.org/en-US/docs/Web/MathML/Fonts
+[mathml-plugin-ie]: https://info.wiris.com/mathplayer-info
+[mathml-mathjax]: https://www.mathjax.org/
diff --git a/source/command-line.md b/source/command-line.md
index f9b1767..55b39a0 100644
--- a/source/command-line.md
+++ b/source/command-line.md
@@ -4,7 +4,7 @@ title: Command-line interface
A command-line interface is provided for extracting information from data files or authority codes,
and for performing coordinate operations.
-That command-line tool is provided for allowing users to experiment some Apache SIS functionalities
+That command-line tool is provided for allowing users to experiment some Apache {{% SIS %}} functionalities
without writing Java code.
For each example, key Java APIs are listed for allowing users to reproduce the functionality
in their own application.
@@ -13,11 +13,11 @@ in their own application.
# Installation {#install}
-Select "Apache SIS 1.1 binary" from the [downloads page](downloads.html) an unzip in any directory.
+Select "Apache {{% SIS %}} {{% version %}} binary" from the [downloads page](downloads.html) an unzip in any directory.
The directory structure will be as below:
{{< highlight text >}}
-apache-sis-1.1
+apache-sis-{{% version %}}
├─ bin
├─ conf
├─ data
@@ -30,26 +30,21 @@ The `bin` sub-directory can be added to the `PATH` environment variable for conv
Example:
{{< highlight bash >}}
-export PATH=$PWD/apache-sis-1.1/bin:$PATH
+export PATH=$PWD/apache-sis-{{% version %}}/bin:$PATH
{{< / highlight >}}
The remaining of this page assumes that the `bin` directory is on the search path.
-If not, the same examples can still be executed by replacing the `sis` command by `./apache-sis-1.1/bin/sis`.
+If not, the same examples can still be executed by replacing the `sis` command by `./apache-sis-{{% version %}}/bin/sis`.
## Optional dependencies {#dependencies}
Every JAR files present in the `lib` sub-directory will be included on the classpath during `sis` command execution.
-By default, the `lib` directory contains the `sis.jar` file with only GeoAPI JAXB API dependencies.
+By default, the `lib` directory contains the `sis-*.jar` files together with GeoAPI, JAXB and Apache Derby dependencies.
However users can add other JAR files in that directory for the following optional dependencies:
-* **Derby driver —**
- needed only if Apache SIS can not locate a JavaDB driver in the JDK installation directory.
- This is not needed on Oracle JDK8 distribution, but needed for all OpenJDK versions and for
- Oracle JDK more recent than 8.
-
* **UCAR netCDF library —**
by default, SIS uses its own embedded netCDF reader which supports only the classical netCDF format, as standardized by OGC.
- If there is a need to read files encoded in GRID or HDF formats, then one can copy the UCAR netCDF library in the `lib` sub-directory.
+ If there is a need to read files encoded in GRID or HDF formats, then copy the UCAR netCDF library in the `lib` sub-directory.
If presents, the UCAR library should be detected and used automatically when SIS can not read a netCDF file by itself.
# Usage {#usage}
@@ -65,12 +60,12 @@ Available commands are:
<table>
<tr><td><code>help</code></td> <td>Show a help overview.</td></tr>
- <tr><td><code>about</code></td> <td>Show information about Apache SIS and system configuration.</td></tr>
+ <tr><td><code>about</code></td> <td>Show information about Apache {{% SIS %}} and system configuration.</td></tr>
<tr><td><code>mime-type</code></td> <td>Show MIME type for the given file.</td></tr>
<tr><td><code>metadata</code></td> <td>Show metadata information for the given file.</td></tr>
<tr><td><code>crs</code></td> <td>Show Coordinate Reference System (CRS) information for the given file or code.</td></tr>
<tr><td><code>identifier</code></td> <td>Show identifiers for metadata and referencing systems in the given file.</td></tr>
- <tr><td><code>transform</code></td> <td>Convert or transform coordinates from given source CRS to target CRS.</td></tr>
+ <tr><td><code>transform</code></td> <td>Convert or transform coordinates from given source {{% CRS %}} to target {{% CRS %}}.</td></tr>
</table>
The set of legal options and the expected number of file arguments depend on the command being executed.
@@ -98,23 +93,23 @@ The reason is that command output may be targeted to a client, while the error m
# Examples {#examples}
The following examples first show how to get a Coordinate Reference System (CRS) from different kinds of definitions.
-CRS contain necessary information for locating points on Earth.
+{{% CRS %}} contain necessary information for locating points on Earth.
Those information include the geodetic datum, the map projection (if any), the axes and their units of measurement.
-When two such CRS are known (the _source_ and the _target_), it is possible to convert or transform points between those CRS.
-However the coordinate operation depends not only on the source and target CRS, but also on the _area of interest_ as shown
+When two such {{% CRS %}} are known (the _source_ and the _target_), it is possible to convert or transform points between those {{% CRS %}}.
+However the coordinate operation depends not only on the source and target {{% CRS %}}, but also on the _area of interest_ as shown
by the example transforming city coordinates in USA and in Canada.
-Then another example show how to get a wider set of metadata, with the CRS as only one specific element of those metadata.
+Then another example show how to get a wider set of metadata, with the {{% CRS %}} as only one specific element of those metadata.
## Print Coordinate Reference Systems (CRS) definition {#crs}
-Apache SIS can read Coordinate Reference System (CRS) definitions from various sources:
+Apache {{% SIS %}} can read Coordinate Reference System (CRS) definitions from various sources:
* Codes from the EPSG geodetic dataset
* Texts in _Well Known Text_ (WKT) format version 1 and 2
-* XML files conform to _Geographic Markup Language_ (GML) schema version 3.2
+* {{% XML %}} files conform to _Geographic Markup Language_ (GML) schema version 3.2
-The easiest way to see a CRS definition is to use an EPSG code.
-The [EPSG geodetic dataset](https://epsg.org/) is a widely-used source of definitions for thousands of Coordinate Reference Systems.
+The easiest way to see a {{% CRS %}} definition is to use an EPSG code.
+The [EPSG geodetic dataset](epsg.html) is a widely-used source of definitions for thousands of Coordinate Reference Systems.
Appache SIS provides a [list of supported codes](tables/CoordinateReferenceSystems.html), which can be queried from the command line.
For example the following command prints the definition of the _"JGD2011 / Japan Plane Rectangular CS VIII"_ Coordinate Reference System:
@@ -146,28 +141,27 @@ sis crs EPSG:6676
Id["EPSG", 6676, "9.7", URI["urn:ogc:def:crs:EPSG:9.7:6676"]],
Remark["Replaces JGD2000 / Japan Plane Rectangular CS VIII (CRS code 2450) with effect from 21st October 2011."]]</pre>
</details>
+<br/>
-The first time that a command requires the EPSG dataset, Apache SIS will propose to download and install a local copy.
-This automatic download happen only when using the command-line tools described in this page.
+The first time that a command requires the EPSG dataset, Apache {{% SIS %}} will propose to download and install a local copy.
+This automatic download happen only when using the command-line tools described in this page or the [JavaFX](javafx.html) application.
Developers who wish to use the EPSG dataset in their applications can use the Maven artifact
documented in [download](downloads.html#epsg) page.
-If Apache SIS does not propose to download the EPSG geodetic dataset, it may be because no Derby database has been found.
-Try to add the Derby optional dependency [as documented here](./epsg.html#command-line).
The above output is compatible with version 2 of _Well Known Text_ (WKT) format.
The output format can be controlled as below:
-* Some applications are restricted to WKT version 1.
- For an output using the legacy WKT 1 format, one can add the `--format wkt1` option to the above command-line.
+* Some applications are restricted to {{% WKT %}} version 1.
+ For an output using the legacy {{% WKT %}} 1 format, add the `--format wkt1` option to above command-line.
-* The “WKT 2” specification allows some flexibility in keyword names and in the way to specify units of measurement.
- By default, the command-line uses this flexibility for producing less verbose but still legal WKT 2 output.
- If an output closer to WKT 2 recommendations is desired, one can add the `--format wkt2` option to the above command.
+* The “{{% WKT %}} 2” specification allows some flexibility in keyword names and in the way to specify units of measurement.
+ By default, the command-line uses this flexibility for producing less verbose but still legal {{% WKT %}} 2 output.
+ If an output closer to {{% WKT %}} 2 recommendations is desired, add the `--format wkt2` option to above command.
The result will be slightly more verbose.
-* Apache SIS can also read and write CRS definitions in the _Geographic Markup Language_ (GML) format.
- For GML output, one can add the `--format xml` option to the above command.
- The result will be much more verbose than WKT outputs.
+* Apache {{% SIS %}} can also read and write {{% CRS %}} definitions in the _Geographic Markup Language_ (GML) format.
+ For {{% GML %}} output, add the `--format xml` option to the above command.
+ The result will be much more verbose than {{% WKT %}} outputs.
Java API for accessing functionalities shown in above examples are:
@@ -176,13 +170,13 @@ Java API for accessing functionalities shown in above examples are:
+ `CRS.fromWKT(String)`
+ `CRS.fromXML(String)`
* Classes in other packages (less convenient but give more control):
- + `org.apache.sis.io.wkt.WKTFormat` — control WKT version, syntax highlighting, _etc._
- + `org.apache.sis.xml.MarshallerPool` — control GML version, link resolutions, _etc._
+ + `org.apache.sis.io.wkt.WKTFormat` — control {{% WKT %}} version, syntax highlighting, _etc._
+ + `org.apache.sis.xml.MarshallerPool` — control {{% GML %}} version, link resolutions, _etc._
## Getting a verified EPSG identifier from a Coordinate Reference System {#identifier}
Because the EPSG geodetic dataset is so commonly used,
-a very common practice is to specify a CRS using only its EPSG code instead than its full definition.
+a very common practice is to specify a {{% CRS %}} using only its EPSG code instead of its full definition.
Such codes can be written in different ways. For example all the following strings are for the same code:
* `"EPSG:4326"`
@@ -193,8 +187,8 @@ Such codes can be written in different ways. For example all the following strin
In a _Well Known Text_ (WKT) string, the code can appear at the bottom of the definition
in an optional element like `ID["EPSG", 4326]` or `AUTHORITY["EPSG", "4326"]`.
However in many cases the code is missing.
-Sometime Apache SIS can find a missing code by comparing a given CRS against the definitions in the EPSG database.
-The following example reads a WKT for the _“NTF (Paris) / Lambert zone II”_ Coordinate Reference System,
+Sometime Apache {{% SIS %}} can find a missing code by comparing a given {{% CRS %}} against the definitions in the EPSG database.
+The following example reads a {{% WKT %}} for the _“NTF (Paris) / Lambert zone II”_ Coordinate Reference System,
but in which the `ID["EPSG", 27572]` element has been intentionally omitted.
Furthermore, the _“NTF (Paris) / Lambert zone II”_ name has been replaced by _“NTF (Paris) / zone to be discovered by the demo”_ name.
Executing the following command:
@@ -209,12 +203,12 @@ produces an output like below:
urn:ogc:def:crs:EPSG:9.7:27572 | NTF (Paris) / Lambert zone II
{{< / highlight >}}
-As we can see, Apache SIS has been able to find back the identifier code and the actual CRS name.
+As we can see, Apache {{% SIS %}} has been able to find back the identifier code and the actual {{% CRS %}} name.
-Sometime a WKT declares wrongly an EPSG code.
-The most frequent case is a WKT that defines a Coordinate Reference System with (_longitude_, _latitude_) axes,
-but declare an EPSG code for a CRS with (_latitude_, _longitude_) axes.
-Apache SIS can detect such mismatches.
+Sometime a {{% WKT %}} declares wrongly an EPSG code.
+The most frequent case is a {{% WKT %}} that defines a Coordinate Reference System with (_longitude_, _latitude_) axes,
+but declare an EPSG code for a {{% CRS %}} with (_latitude_, _longitude_) axes.
+Apache {{% SIS %}} can detect such mismatches.
For example executing the following command:
{{< highlight bash >}}
@@ -230,9 +224,9 @@ Legend:
! Identified object matches definition provided by authority except for coordinate system axes.
{{< / highlight >}}
-Apache SIS can perform such analysis because it “understands” the CRS definition.
-This analysis capability can be tested by altering the CRS definition.
-The next example asks the identifier of a CRS which is normally defined as below:
+Apache {{% SIS %}} can perform such analysis because it “understands” the {{% CRS %}} definition.
+This analysis capability can be tested by altering the {{% CRS %}} definition.
+The next example asks the identifier of a {{% CRS %}} which is normally defined as below:
{{< highlight text >}}
ProjectedCRS["WGS 84 / Mercator 41",
@@ -242,7 +236,7 @@ ProjectedCRS["WGS 84 / Mercator 41",
(... definition omitted for brevity ...)
{{< / highlight >}}
-However in this example, we will provide a CRS defined as below:
+However in this example, we will provide a {{% CRS %}} defined as below:
{{< highlight text >}}
ProjectedCRS["Scaled Mercator",
@@ -265,10 +259,11 @@ produces an output like below:
urn:ogc:def:crs:EPSG:9.7:3994 | WGS 84 / Mercator 41
{{< / highlight >}}
-In above example, Apache SIS used the fact that a
+In above example, Apache {{% SIS %}} used the fact that a
_“Mercator (variant A)”_ projection with a _“Scale factor at natural origin”_ parameter value of 0.755799… on the WGS84 datum is numerically equivalent to a
_“Mercator (variant B)”_ projection with a _“Latitude of 1st standard parallel”_ parameter value of 41° on the same datum.
-This recognition allowed SIS to return the EPSG:3994 code even if it stands for a CRS defined as a _“Mercator (variant B)”_ projection rather than variant A.
+This recognition allowed SIS to return the EPSG:3994 code
+even if it stands for a {{% CRS %}} defined as a _“Mercator (variant B)”_ projection rather than variant A.
Java API for accessing functionalities shown in above example are:
@@ -279,8 +274,8 @@ Java API for accessing functionalities shown in above example are:
## Performing coordinate conversions or transformations {#coordinateOperation}
-Coordinates represented in a given CRS can be transformed into coordinates represented in another CRS.
-The coordinate transformations depend mostly on the _source_ and _target_ CRS, but the _area of interest_
+Coordinates represented in a given {{% CRS %}} can be transformed into coordinates represented in another {{% CRS %}}.
+The coordinate transformations depend mostly on the _source_ and _target_ {{% CRS %}}, but the _area of interest_
can also have an influence; while optional, that area should be specified when it is known.
The following example transform coordinates from the North American Datum 1927 (EPSG:4267) to WGS84 (EPSG:4326).
@@ -356,23 +351,17 @@ Java API for accessing functionalities shown in above examples are:
## Extracting ISO 19115 Metadata {#metadata}
-SIS can read the header of a data file and print the metadata in an ISO 19115 structure.
+Apache {{% SIS %}} can read the header of a data file and print the metadata in an {{% ISO %}} 19115 structure.
The data file given in argument can be a local file or a URL.
By default, the metadata are shown in a relatively compact tree-table format.
-But the metadata can optionally be exported as an ISO 19139 compliant XML document.
-
-<blockquote><b>Note:</b>
-As of SIS 1.1, only ISO 19139 XML documents, CF-compliant netCDF files, GeoTIFF files, GPX files
-or Moving Features CSV files can be given in argument to this command.
-</blockquote>
-
-The following example show the metadata of a netCDF file accessible from the web:
+But the metadata can optionally be exported as an {{% ISO %}} 19139 compliant XML document.
+The following example shows the metadata of a netCDF file accessible from the web:
{{< highlight bash >}}
sis metadata https://github.com/opengeospatial/geoapi/raw/master/geoapi-conformance/src/main/resources/org/opengis/test/dataset/Cube4D_projected_float.nc
{{< / highlight >}}
<details>
- <summary>Below is an extract of the above command output:</summary>
+ <summary>Fragment of expected output (click to expand):</summary>
<pre>Metadata
├─Identification info
│ ├─Citation………………………………………………………………………………… Sea Surface Temperature Analysis Model
@@ -403,8 +392,9 @@ The following example show the metadata of a netCDF file accessible from the web
├─Descriptor………………………………………………………………… Sea temperature
└─Sequence identifier………………………………………… SST</pre>
</details>
+<br/>
-Adding the `--format xml` option to the above command will format the same metadata in a XML document.
+Adding the `--format xml` option to the above command will format the same metadata in a {{% XML %}} document.
The output is not shown in this page because of its verbosity.
Java API for accessing functionalities shown in above examples are:
@@ -418,6 +408,6 @@ Java API for accessing functionalities shown in above examples are:
# Performance consideration {#performance}
If there is a large amount of files to process, invoking the above command many time may be inefficient
-since it would restart a new JVM on every invocation.
+because it would restart a new JVM on every invocation.
If the operation requires the EPSG dataset, booting the Derby database also has a significant cost.
For such cases, it is more efficient to loop inside a small Java program using the [SIS API](apidocs/index.html).
diff --git a/source/contributor.md b/source/contributor.md
index 81d268f..9dc8c58 100644
--- a/source/contributor.md
+++ b/source/contributor.md
@@ -2,14 +2,14 @@
title: New contributor
---
-Improving and extending SIS requires extensive knowledge of geographic information science,
+Improving and extending Apache {{% SIS %}} requires extensive knowledge of geographic information science,
object oriented programming, the Java language, and of the library itself. Contributors should
expect that they will need to learn a great deal before being able to become productive.
However, the effort required to become productive should improve the contributor's understanding
and knowledge of geographic information systems, of geodetic and geographic science, and of
effective computer programming.
-This document is expected to evolve as the SIS project develops its own mode of operation.
+This document is expected to evolve as the Apache {{% SIS %}} project develops its own mode of operation.
{{< toc >}}
@@ -19,8 +19,8 @@ All contributors arrive to the project with different knowledge bases, some with
backgrounds, some with a background in computer science, and others with geographic backgrounds
or even no training in geographic information science at all. By sharing the richness of our
individual backgrounds we have acquired a list of subjects which we consider critical to fully
-understanding the SIS project. New contributors are highly encouraged to explore these
-areas if they have no or little knowledge of them.
+understanding the Apache {{% SIS %}} project.
+New contributors are highly encouraged to explore these areas if they have no or little knowledge of them.
## Geographic Information Systems and Science {#science}
@@ -32,11 +32,11 @@ arise frequently and are worth understanding.
A good general introduction to the field is the book _Geographic Information Systems and Science_
by Paul A. Longley, Michael F. Goodchild, David J. Maguire and David W. Rhind published in its
second edition by John Wiley and Sons Ltd. in 2004.
-Apache SIS also provides an introduction in the [Developer guide](book/en/developer-guide.html).
+Apache {{% SIS %}} also provides an introduction in the [Developer guide](book/en/developer-guide.html).
## The ISO/OGC Geospatial Model {#ogc}
-SIS builds on the standards developed through a collaboration between the International
+Apache {{% SIS %}} builds on the standards developed through a collaboration between the International
Organization for Standardization (ISO) and the Open Geospatial Consortium (OGC).
Contributors to SIS should have at least a basic understanding of the model developed in the
{{% ISO %}} 19000 series of specifications, starting with the Abstract model and working through the
@@ -45,27 +45,27 @@ identical versions of standards which have evolved from the collaboration. The {
are available for the [{{% OGC %}} standards and specification][standards] page.
As time progresses, we hope to develop documentation material to introduce the {{% ISO %}} 19000 specification series.
-Most of the documentation provided by SIS can be found in the [Developer guide](book/en/developer-guide.html).
+Some of the documentation provided by Apache {{% SIS %}} can be found in the [Developer guide](book/en/developer-guide.html).
## Object-Oriented Programming in Java {#java}
-SIS is a library designed to be used by other programmers. To play this role effectively,
-SIS must consider the various ways that users can reuse Java code: not only through object
-instantiation and method calls but also through inheritance. SIS pays special attention to
-accessibility constraints ensuring that only the classes and methods which are offered for
-use are publicly accessible and that these methods are fully and correctly documented in javadoc.
+Apache {{% SIS %}} is a library designed to be used by other programmers.
+To play this role effectively, SIS must consider the various ways that users can reuse Java code:
+not only through object instantiation and method calls but also through inheritance.
+Apache {{% SIS %}} pays special attention to accessibility constraints ensuring that only the classes and methods
+which are offered for use are publicly accessible and that these methods are fully and correctly documented in javadoc.
-Contributors are highly recommended to read the book _Effective Java_ by Joshua Block, published
-in its second edition by Addison-Wesley in 2008. The book explains the importance of certain
+Contributors are highly recommended to read the book _Effective Java_ by Joshua Block,
+published in its third edition in 2017. The book explains the importance of certain
elements in the Java language and discusses subtleties of the language and its use.
Most importantly, the book reveals the full scope a programmer must consider when developing a code library.
The [Recommended code patterns](code-patterns.html) page also discusses some elements
-of special importance to Apache SIS.
+of special importance to Apache {{% SIS %}}.
## Mathematical Background {#math}
-SIS frequently deals with complex calculations using relatively simple mathematics of
+Apache {{% SIS %}} frequently deals with complex calculations using relatively simple mathematics of
trigonometry and matrix algebra. The coordinate operations of the Referencing modules involve
trigonometric transformations on a flattened ellipsoid of rotation, the image transformations in
the Coverage modules and in the Rendering system involve extensive use of Affine transforms, and
@@ -80,13 +80,13 @@ affine transformations are usually applied as a matrix operation applied to a co
There are numerous introductions to affine transformations available on the World Wide Web since
the concept is central to all graphics programming.
-## The GeoAPI Interfaces {#geoapi}
+# Projects Knowledge {#projects}
-SIS is build partially as an implementation of the GeoAPI interfaces. GeoAPI defines a set
-of objects offering particular methods thereby providing an interpretation of the {{% ISO %}}/{{% OGC %}}
-standards in the Java language. GeoAPI therefore defines the core of the model implemented
-by Apache SIS.
+## The GeoAPI Interfaces {#geoapi}
+Apache {{% SIS %}} is build partially as an implementation of the GeoAPI interfaces. GeoAPI defines a set of objects
+offering particular methods thereby providing an interpretation of the {{% ISO %}}/{{% OGC %}} standards
+in the Java language. GeoAPI therefore defines the core of the model implemented by Apache {{% SIS %}}.
GeoAPI can most easily be learned by exploring the [GeoAPI Javadoc][geoapi].
## The SIS library modules {#modules}
diff --git a/source/downloads.md b/source/downloads.md
index 5497b94..c55007d 100644
--- a/source/downloads.md
+++ b/source/downloads.md
@@ -2,28 +2,28 @@
title: Apache SIS downloads
---
-Apache SIS 1.1 is now available.
-See the [release notes](release-notes/1.1.html) for a list of changes since the previous version.
+Apache {{% SIS %}} {{% version %}} is now available.
+See the [release notes](release-notes/{{% version %}}.html) for a list of changes since the previous version.
-Apache SIS releases are available under the [Apache License, Version 2.0][license].
+Apache {{% SIS %}} releases are available under the [Apache License, Version 2.0][license].
See the `NOTICE` file contained in each release artifact for applicable copyright attribution notices.
{{< toc >}}
# Download ZIP files {#bundles}
-Apache SIS is distributed in the form of Java source code in a multi-modules Apache Maven project.
+Apache {{% SIS %}} is distributed in the form of Java source code in a multi-modules Apache Maven project.
For convenience, an aggregated Javadoc and a pre-compiled JAR file are available as separated downloads.
The precompiled JAR file contains most modules and dependencies in a single archive for easier inclusion
in a classpath.
-* [Apache SIS 1.1 sources][src] \[[PGP][src-PGP]\] \[[SHA 512][src-SHA]\]
-* [Apache SIS 1.1 javadoc][doc] \[[PGP][doc-PGP]\] \[[SHA 512][doc-SHA]\]
-* [Apache SIS 1.1 binary][bin] \[[PGP][bin-PGP]\] \[[SHA 512][bin-SHA]\]
+* [Apache SIS {{% version %}} sources][src] \[[PGP][src-PGP]\] \[[SHA 512][src-SHA]\]
+* [Apache SIS {{% version %}} javadoc][doc] \[[PGP][doc-PGP]\] \[[SHA 512][doc-SHA]\]
+* [Apache SIS {{% version %}} binary][bin] \[[PGP][bin-PGP]\] \[[SHA 512][bin-SHA]\]
## Verify signatures {#release-gpg}
-All downloads can be verified using the Apache SIS code signing [KEYS][keys].
+All downloads can be verified using the Apache {{% SIS %}} code signing [KEYS][keys].
The PGP (_Pretty Good Privacy_) signatures can be verified using any OpenPGP implementation, for example GPG (_GNU Privacy Guard_).
First download the [KEYS][keys] file and the `.asc` signature files for the relevant release packages.
Make sure you get these files from the main distribution directory, rather than from a mirror.
@@ -52,14 +52,13 @@ pgpv apache-sis-X.Y.Z.zip.asc
# Download as a Maven dependency {#maven}
-An easy approach to integrate Apache SIS into a Java project uses the [Apache Maven][maven]
+An easy approach to integrate Apache {{% SIS %}} into a Java project uses the [Apache Maven][maven]
dependency management tool to automatically obtain the required Java Archives (JAR) files from the network.
Below are examples of declarations in a `pom.xml` file for building a project with a SIS core module.
-If running on Java 11 or higher, at least one of the two next dependencies is also required:
{{< highlight xml >}}
<properties>
- <sis.version>1.1</sis.version>
+ <sis.version>{{% version %}}</sis.version>
</properties>
<dependencies>
@@ -70,21 +69,11 @@ If running on Java 11 or higher, at least one of the two next dependencies is al
</dependency>
</dependencies>
-<!-- The following dependency can be omitted on Java 8 (unconditionally), or
- on Java 9 and 10 if the "--add-modules java.xml.bind" option is used. -->
+<!-- The following dependency can be omitted if XML support is not desired. -->
<dependency>
<groupId>org.glassfish.jaxb</groupId>
<artifactId>jaxb-runtime</artifactId>
- <version>2.3.2</version>
- <scope>runtime</scope>
-</dependency>
-
-<!-- Above JAXB dependency can be replaced by the following dependency
- if no XML (un)marshalling is wanted. This dependency is lighter. -->
-<dependency>
- <groupId>jakarta.xml.bind</groupId>
- <artifactId>jakarta.xml.bind-api</artifactId>
- <version>2.3.2</version>
+ <version>2.3.3</version>
<scope>runtime</scope>
</dependency>
{{< / highlight >}}
@@ -119,14 +108,14 @@ See [How to use EPSG geodetic dataset](epsg.html) page for more information.
[maven]: http://maven.apache.org/
[keys]: https://www.apache.org/dist/sis/KEYS
[license]: http://www.apache.org/licenses/LICENSE-2.0
-[src]: http://www.apache.org/dyn/closer.cgi/sis/1.1/apache-sis-1.1-src.zip
-[doc]: http://www.apache.org/dyn/closer.cgi/sis/1.1/apache-sis-1.1-doc.zip
-[bin]: http://www.apache.org/dyn/closer.cgi/sis/1.1/apache-sis-1.1-bin.zip
-[src-PGP]: https://www.apache.org/dist/sis/1.1/apache-sis-1.1-src.zip.asc
-[doc-PGP]: https://www.apache.org/dist/sis/1.1/apache-sis-1.1-doc.zip.asc
-[bin-PGP]: https://www.apache.org/dist/sis/1.1/apache-sis-1.1-bin.zip.asc
-[src-SHA]: https://www.apache.org/dist/sis/1.1/apache-sis-1.1-src.zip.sha512
-[doc-SHA]: https://www.apache.org/dist/sis/1.1/apache-sis-1.1-doc.zip.sha512
-[bin-SHA]: https://www.apache.org/dist/sis/1.1/apache-sis-1.1-bin.zip.sha512
+[src]: http://www.apache.org/dyn/closer.cgi/sis/{{% version %}}/apache-sis-{{% version %}}-src.zip
+[doc]: http://www.apache.org/dyn/closer.cgi/sis/{{% version %}}/apache-sis-{{% version %}}-doc.zip
+[bin]: http://www.apache.org/dyn/closer.cgi/sis/{{% version %}}/apache-sis-{{% version %}}-bin.zip
+[src-PGP]: https://www.apache.org/dist/sis/{{% version %}}/apache-sis-{{% version %}}-src.zip.asc
+[doc-PGP]: https://www.apache.org/dist/sis/{{% version %}}/apache-sis-{{% version %}}-doc.zip.asc
+[bin-PGP]: https://www.apache.org/dist/sis/{{% version %}}/apache-sis-{{% version %}}-bin.zip.asc
+[src-SHA]: https://www.apache.org/dist/sis/{{% version %}}/apache-sis-{{% version %}}-src.zip.sha512
+[doc-SHA]: https://www.apache.org/dist/sis/{{% version %}}/apache-sis-{{% version %}}-doc.zip.sha512
+[bin-SHA]: https://www.apache.org/dist/sis/{{% version %}}/apache-sis-{{% version %}}-bin.zip.sha512
[EPSG]: https://epsg.org/
[EPSG-ToU]: https://epsg.org/terms-of-use.html
diff --git a/source/epsg.md b/source/epsg.md
index 5f0814e..a7600c8 100644
--- a/source/epsg.md
+++ b/source/epsg.md
@@ -6,14 +6,14 @@ The [EPSG geodetic dataset][EPSG] is a de-facto standard providing
[thousands of Coordinate Reference System (CRS) definitions](tables/CoordinateReferenceSystems.html)
together with information about how to perform coordinate operations, their accuracies and their domains of validity.
The EPSG dataset is owned and maintained by the [International Association of Oil & Gas producers][IOGP].
-Usage of EPSG dataset with Apache SIS is optional but strongly recommended:
+Usage of EPSG dataset with Apache {{% SIS %}} is optional but strongly recommended:
without that geodetic dataset, only a small subset of CRS definitions will be available
(basically the constants enumerated in the [`CommonCRS`](apidocs/org/apache/sis/referencing/CommonCRS.html) Java class)
unless full definitions are provided in _Well Known Text_ (WKT) or _Geographic Markup Language_ (GML) formats.
Furthermore, coordinate operations between any given pair of CRS may be less accurate
-and their domains of validity may be unspecified if Apache SIS can not query EPSG.
+and their domains of validity may be unspecified if Apache {{% SIS %}} can not query EPSG.
-The EPSG geodetic dataset is not distributed with Apache SIS because the [EPSG terms of use][EPSG-ToU]
+The EPSG geodetic dataset is not distributed with Apache {{% SIS %}} because the [EPSG terms of use][EPSG-ToU]
are incompatible with Apache license. The following items are quoted from those terms of use:
* The [EPSG][EPSG] Facilities are published by [IOGP][IOGP] at no charge. Distribution for profit is forbidden.
@@ -25,7 +25,7 @@ are incompatible with Apache license. The following items are quoted from those
of the information provided that numeric equivalence is achieved.
* No data that has been modified other than as permitted in these Terms of Use shall be attributed to the EPSG Dataset.
-In order to use the EPSG geodetic dataset with Apache SIS, apply *one* of the following choices:
+In order to use the EPSG geodetic dataset with Apache {{% SIS %}}, apply *one* of the following choices:
{{< toc >}}
@@ -40,28 +40,30 @@ sis crs EPSG:6676
The first time that the command-line tool needs to query EPSG, it will prompt the user for authorization
to download EPSG geodetic dataset from Maven Central. If the user accepts EPSG terms of use, then a local
-copy of the EPSG geodetic dataset will be created and stored in the `apache-sis-1.1/data` sub-directory.
+copy of the EPSG geodetic dataset will be created and stored in the `apache-sis-{{% version %}}/data` sub-directory.
## Use the local copy in other applications {#use-local}
For using the installed EPSG geodetic dataset in your own application, apply *one* of the following choices:
-* Set the `SIS_DATA` environment variable to the path of `apache-sis-1.1/data` directory _(preferred choice)_.
-* Set the `derby.system.home` Java property to the path of `apache-sis-1.1/data/Databases` directory.
+* Set the `SIS_DATA` environment variable to the path of `apache-sis-{{% version %}}/data` directory _(recommended)_.
+* Set the `derby.system.home` Java property to the path of `apache-sis-{{% version %}}/data/Databases` directory.
Alternatively `SIS_DATA` or `derby.system.home` can be set to the path of any other directory which contain the same files.
-Examples are shown below for Unix systems, assuming that the current directory is the directory where `apache-sis-1.1-bin.zip`
+Examples are shown below for Unix systems, assuming that the current directory is the directory where `apache-sis-{{% version %}}-bin.zip`
has been unzipped:
{{< highlight bash >}}
-export SIS_DATA=apache-sis-1.1/data
-java -classpath apache-sis-1.1/lib/sis.jar:myApp.jar myMainClass
+export SIS_DATA=apache-sis-{{% version %}}/data
+java -classpath apache-sis-{{% version %}}/lib/sis-referencing.jar:myApp.jar myMainClass
{{< / highlight >}}
If the `SIS_DATA` environment variable can not be set, Java property can be used as a fallback:
-{{< highlight java >}}
-java -Dderby.system.home=apache-sis-1.1/data/Databases -classpath apache-sis-1.1/lib/sis.jar:myApp.jar myMainClass
+{{< highlight bash >}}
+java -Dderby.system.home=apache-sis-{{% version %}}/data/Databases \
+ -classpath apache-sis-{{% version %}}/lib/sis-referencing.jar:myApp.jar \
+ myMainClass
{{< / highlight >}}
# Add a Maven dependency {#maven}
@@ -74,10 +76,10 @@ In both cases, we assume that developers who add those dependencies explicitely
## As database installer {#maven-epsg}
-With `sis-epsg` artifact on the classpath, Apache SIS will create a local copy of EPSG database when first needed.
+With `sis-epsg` artifact on the classpath, Apache {{% SIS %}} will create a local copy of EPSG database when first needed.
The target database must be specified by users with *one* of the following choices:
-* Set the `SIS_DATA` environment variable to the path of an initially empty directory _(preferred choice)_.
+* Set the `SIS_DATA` environment variable to the path of an initially empty directory _(recommended)_.
The specified directory must exist, but sub-directories will be created as needed.
* Set the `derby.system.home` Java property to the path of an initially empty directory,
or a directory that contain other Derby databases. The specified directory must exist.
@@ -93,7 +95,7 @@ if that database is specified by JNDI):
<dependency>
<groupId>org.apache.sis.non-free</groupId>
<artifactId>sis-epsg</artifactId>
- <version>1.1</version>
+ <version>{{% version %}}</version>
<scope>runtime</scope>
</dependency>
@@ -130,7 +132,7 @@ Note that `sis-epsg` and `sis-embedded-data` should not be specified in the same
<dependency>
<groupId>org.apache.sis.non-free</groupId>
<artifactId>sis-embedded-data</artifactId>
- <version>1.1</version>
+ <version>{{% version %}}</version>
<scope>runtime</scope>
</dependency>
</dependencies>
@@ -146,11 +148,11 @@ or by uncompressing the `sis-embedded-data.jar` file locally.
# Use Java Naming and Directory Interface {#jndi}
-While Apache SIS uses Apache Derby by default, it is also possible to use another database software like HSQL or PostgreSQL.
+While Apache {{% SIS %}} uses Apache Derby by default, it is also possible to use another database software like HSQL or PostgreSQL.
For using an arbitrary database, register a `javax.sql.DataSource` instance through the Java Naming and Directory Interface (JNDI).
That registration can be done programmatically (by Java code) or by configuring XML files in some environments.
The database must exist but can be empty, in which case it will be populated with an EPSG schema when first needed
-if the <code style="white-space:normal">org.apache.sis.non-free:sis-epsg:1.1</code> dependency is on the classpath
+if the <code style="white-space:normal">org.apache.sis.non-free:sis-epsg:{{% version %}}</code> dependency is on the classpath
(see [above section](#maven-epsg)).
## Registration by Java code {#jndi-java}
@@ -160,8 +162,8 @@ Registration can be done by the following Java code, provided that a JNDI implem
{{< highlight java >}}
// Example using PostgreSQL data source (org.postgresql.ds.PGSimpleDataSource)
PGSimpleDataSource ds = new PGSimpleDataSource();
-ds.setServerName("localhost");
ds.setDatabaseName("SpatialMetadata");
+// Server default to "localhost".
// Registration assuming that a JNDI implementation is available
Context env = (Context) InitialContext.doLookup("java:comp/env");
@@ -170,7 +172,7 @@ env.bind("jdbc/SpatialMetadata", ds);
If there is no JNDI environment, the `org.apache.sis.setup.Configuration` class can be used as a fallback:
-{{< highlight java >}}
+{{< highlight bash >}}
// Fallback if no JNDI environment is available.
Configuration.current().setDatabase(() -> ds);
{{< / highlight >}}
@@ -178,7 +180,7 @@ Configuration.current().setDatabase(() -> ds);
## Registration in web application containers {#jndi-webapp}
JNDI implementations are provided by web application containers like Apache Tomcat.
-When Apache SIS is used in a JavaEE container, the data source can be configured as below:
+When Apache {{% SIS %}} is used in a JavaEE container, the data source can be configured as below:
1. Make the JDBC driver available to the web container and its applications.
On Tomcat, this is accomplished by installing the driver's JAR files into the `$CATALINA_HOME/lib` directory.
@@ -219,7 +221,7 @@ export JAVA_OPTS=-Dderby.system.home=$SIS_DATA/Databases
5. If using Derby, verify on the `localhost:8080/derby/derbynet` page (skip this step if another database is used).
-More advanced configurations are possible. For example Tomcat can invoke a custom Java method instead than
+More advanced configurations are possible. For example Tomcat can invoke a custom Java method instead of
fetching the data source from the `context.xml` file.
[IOGP]: https://www.iogp.org/
diff --git a/source/faq.md b/source/faq.md
index cc64514..f95095c 100644
--- a/source/faq.md
+++ b/source/faq.md
@@ -2,7 +2,7 @@
title: Frequently asked questions
---
-This page lists some Frequently Asked Questions (FAQ) when using Apache SIS.
+This page lists some Frequently Asked Questions (FAQ) when using Apache {{% SIS %}}.
This FAQ is also [available in French](faq_fr.html).
{{< toc >}}
@@ -33,11 +33,11 @@ public class MyApp {
CoordinateReferenceSystem sourceCRS = CommonCRS.WGS84.geographic();
CoordinateReferenceSystem targetCRS = CommonCRS.WGS84.universal(40, 14); // Get whatever zone is valid for 14°E.
CoordinateOperation operation = CRS.findOperation(sourceCRS, targetCRS, null);
-
- // The above lines are costly and should be performed only once before to project many points.
- // In this example, the operation that we got is valid for coordinates in geographic area from
- // 12°E to 18°E (UTM zone 33) and 0°N to 84°N.
-
+ /*
+ * The above lines are costly and should be performed only once before to project many points.
+ * In this example, the operation that we got is valid for coordinates in geographic area from
+ * 12°E to 18°E (UTM zone 33) and 0°N to 84°N.
+ */
DirectPosition ptSrc = new DirectPosition2D(40, 14); // 40°N 14°E
DirectPosition ptDst = operation.getMathTransform().transform(ptSrc, null);
@@ -49,22 +49,22 @@ public class MyApp {
### Which map projections are supported? {#operation-methods}
-The operation _methods_ (including, but not limited to, map projections) supported by Apache SIS
-are listed in the [Coordinate Operation Methods](tables/CoordinateOperationMethods.html) page.
+The operation _methods_ (including, but not limited to, map projections) supported by
+Apache {{% SIS %}} are listed in the [Coordinate Operation Methods](tables/CoordinateOperationMethods.html) page.
The amount of map projection methods is relatively small,
-but the amount of _projected {{% CRS %}}_ that we can build from them can be very large.
+but the amount of _projected Coordinate Reference Systems_ that we can build from them can be very large.
For example with only three family of methods (_Cylindrical Mercator_, _Transverse Mercator_ and _Lambert Conic Conformal_)
used with different parameter values, we can cover thousands of projected {{% CRS %}} listed in the EPSG geodetic dataset.
In order to use a map projection method, we need to know the value to assign to the projection parameters.
For convenience, thousands of projected {{% CRS %}} with pre-defined parameter values are are assigned a unique identifier.
A well-known source of such definitions is the EPSG geodetic dataset, but other authorities also exist.
-The predefined {{% CRS %}} known to Apache SIS are listed in the
+The predefined {{% CRS %}} known to Apache {{% SIS %}} are listed in the
[Coordinate Reference Systems](tables/CoordinateReferenceSystems.html) page.
### What is the axis order issue and how is it addressed? {#axisOrder}
-The axis order is specified by the authority (typically a national agency) defining the Coordinate Reference System ({{% CRS %}}).
+The axis order is specified by the authority (typically a national agency) defining the Coordinate Reference System (CRS).
The order depends on the {{% CRS %}} type and the country defining the {{% CRS %}}.
In the case of geographic {{% CRS %}}, the (_latitude_, _longitude_) axis order is widely used by geographers and pilots for centuries.
However software developers tend to consistently use the (_x_, _y_) order for every kind of {{% CRS %}}.
@@ -83,13 +83,13 @@ Recent {{% OGC %}} standards mandate the use of axis order as defined by the aut
Oldest {{% OGC %}} standards used the (_x_, _y_) axis order instead, ignoring any authority specification.
Among the legacy {{% OGC %}} standards that used the non-conform axis order,
an influent one is version 1 of the _Well Known Text_ (WKT) format specification.
-According that widely-used format, WKT definitions without explicit `AXIS[...]` elements
+According that widely-used format, {{% WKT %}} definitions without explicit `AXIS[…]` elements
shall default to (_longitude_, _latitude_) or (_x_, _y_) axis order.
-In version 2 of the WKT format, `AXIS[...]` elements are no longer optional
-and should contain an explicit `ORDER[...]` sub-element for making the intended order yet more obvious.
+In version 2 of the {{% WKT %}} format, `AXIS[…]` elements are no longer optional
+and should contain an explicit `ORDER[…]` sub-element for making the intended order yet more obvious.
Many software products still use the old (_x_, _y_) axis order, sometime because it is easier to implement.
-But Apache SIS rather defaults to axis order _as defined by the authority_ (except when parsing a WKT 1 definition),
+But Apache {{% SIS %}} rather defaults to axis order _as defined by the authority_ (except when parsing a {{% WKT %}} 1 definition),
but allows changing axis order to the (_x_, _y_) order after {{% CRS %}} creation.
This change can be done with the following code:
@@ -102,7 +102,7 @@ crs = AbstractCRS.castOrCopy(crs).forConvention(AxesConvention.RIGHT_HANDED)
### How do I instantiate a Universal Transverse Mercator (UTM) projection? {#UTM}
-If the UTM zone is unknown, an easy way is to invoke the `universal(...)` method on one of the `CommonCRS` pre-defined constants.
+If the UTM zone is unknown, an easy way is to invoke the `universal(…)` method on one of the `CommonCRS` pre-defined constants.
That method receives in argument a geographic coordinate in (_latitude_, _longitude_) order and computes the UTM zone from it.
See the [above Java code example](#transform-point).
@@ -139,8 +139,8 @@ Those methods have "(Spherical)" in their name, for example _"Mercator (Spherica
Those projection methods can be used in Well Known Text (WKT) definitions.
If there is a need to use spherical formulas with a projection that does not have a "(Spherical)" counterpart,
-this can be done with explicit declarations of `"semi_major"` and `"semi_minor"` parameter values in the WKT definition.
-Those parameter values are usually inferred from the datum, but Apache SIS allows explicit declarations to override the inferred values.
+this can be done with explicit declarations of `"semi_major"` and `"semi_minor"` parameter values in the {{% WKT %}} definition.
+Those parameter values are usually inferred from the datum, but Apache {{% SIS %}} allows explicit declarations to override the inferred values.
### How can I identify the projection kind of a CRS? {#projectionKind}
@@ -153,17 +153,18 @@ listed in the [Coordinate Operation Methods](tables/CoordinateOperationMethods.h
The _identifier_ of a Coordinate Reference System (CRS) object can be obtained by the `getIdentifiers()` method,
which usually return a collection of zero or one element.
If the {{% CRS %}} has been created from a Well Known Text (WKT) parsing
-and the WKT ends with an `AUTHORITY["EPSG", "xxxx"]` (WKT version 1) or `ID["EPSG", xxxx]` (WKT version 2) element,
+and the {{% WKT %}} ends with an `AUTHORITY["EPSG", "xxxx"]` ({{% WKT %}} version 1)
+or `ID["EPSG", xxxx]` ({{% WKT %}} version 2) element,
then the identifier (an EPSG numerical code in this example) is the _xxxx_ value in that element.
If the {{% CRS %}} has been created from the EPSG geodetic dataset (for example by a call to `CRS.forCode("EPSG:xxxx")`),
then the identifier is the _xxxx_ code given to that method.
If the {{% CRS %}} has been created in another way, then the collection returned by the `getIdentifiers()` method
may or may not be empty depending if the program that created the {{% CRS %}} took the responsibility of providing identifiers.
-If the collection of identifiers is empty, the most effective fix is to make sure that the WKT
-contains an `AUTHORITY` or `ID` element (assuming that the {{% CRS %}} was parsed from a WKT).
-If this is not possible, then the `org.apache.sis.referencing.IdentifiedObjects` class contains some convenience methods which may help.
-In the following example, the call to `lookupEPSG(...)` will scan the EPSG database for a {{% CRS %}} equals
+If the collection of identifiers is empty, the most effective fix is to make sure that the {{% WKT %}}
+contains an `AUTHORITY` or `ID` element (assuming that the {{% CRS %}} was parsed from a {{% WKT %}}).
+If this is not possible, then the `org.apache.sis.referencing.IdentifiedObjects` class contains some convenience methods which may help.
+In the following example, the call to `lookupEPSG(…)` will scan the EPSG database for a {{% CRS %}} equals
(ignoring metadata) to the given one. *Note that this scan is sensitive to axis order.*
Most geographic {{% CRS %}} in the EPSG database are declared with (_latitude_, _longitude_) axis order.
Consequently if the given {{% CRS %}} has (_longitude_, _latitude_) axis order, then the scan is likely to find no match.
@@ -176,7 +177,7 @@ if (identifier != null) {
}
{{< / highlight >}}
-### How do I get the "urn:ogc:def:crs:..." URN of an existing CRS? {#lookupURN}
+### How do I get the "urn:ogc:def:crs:…" URN of an existing CRS? {#lookupURN}
{{% OGC %}} defines URN for {{% CRS %}} identifiers, for example `"urn:ogc:def:crs:epsg:7.1:4326"`
where `"7.1"` is the version of the EPSG database used.
@@ -190,13 +191,13 @@ CoordinateReferenceSystem myCRS = ...;
String urn = IdentifiedObjects.lookupURN(myCRS);
{{< / highlight >}}
-### Can I rely on IdentifiedObjects.lookupEPSG(...) to work correctly as the inverse of CRS.forCode(...)? {#lookupReliability}
+### Is IdentifiedObjects.lookupEPSG(…) a reliable inverse of CRS.forCode(…)? {#lookupReliability}
For {{% CRS %}} created from the EPSG geodetic dataset, usually yes.
-Note however that `IdentifiedObjects.getIdentifier(...)` is cheaper and insensitive to the details of {{% CRS %}} definition,
+Note however that `IdentifiedObjects.getIdentifier(…)` is cheaper and insensitive to the details of {{% CRS %}} definition,
since it never query the database. But it works only if the {{% CRS %}} declares explicitly its code,
which is the case for {{% CRS %}} created from the EPSG database or parsed from a Well Known Text (WKT) having an `AUTHORITY` or `ID` element.
-The `lookupEPSG(...)` method on the other hand is robust to erroneous code declaration,
+The `lookupEPSG(…)` method on the other hand is robust to erroneous code declaration,
since it always compares the {{% CRS %}} with the database content.
But it may fail if there is slight mismatch (for example rounding errors in projection parameters)
between the supplied {{% CRS %}} and the {{% CRS %}} found in the database.
@@ -205,19 +206,19 @@ between the supplied {{% CRS %}} and the {{% CRS %}} found in the database.
Two Coordinate Reference Systems may not be considered equal if they are associated to different metadata
(name, identifiers, scope, domain of validity, remarks), even though they represent the same logical {{% CRS %}}.
-In order to test if two {{% CRS %}} are functionally equivalent, use `Utilities.equalsIgnoreMetadata(myFirstCRS, mySecondCRS)`.
+In order to test if two {{% CRS %}} are functionally equivalent, use `Utilities.equalsIgnoreMetadata(myFirstCRS, mySecondCRS)`.
### Are CRS objects safe for use as keys in HashMap? {#crsHashCode}
Yes, every classes defined in the `org.apache.sis.referencing.crs`, `cs` and `datum` packages
define properly their `equals(Object)` and `hashCode()` methods.
-The Apache SIS library itself uses {{% CRS %}} objects in `HashMap`-like containers for caching purpose.
+The Apache {{% SIS %}} library itself uses {{% CRS %}} objects in `HashMap`-like containers for caching purpose.
## Coordinate transformations {#transforms}
### My transformed coordinates are totally wrong! {#axisOrderInTransforms}
-This is most frequently caused by ordinate values given in the wrong order.
+This is most frequently caused by coordinate values given in the wrong order.
Developers tend to assume a (_x_, _y_) or (_longitude_, _latitude_) axis order.
But geographers and pilots are using (_latitude_, _longitude_) axis order for centuries,
and the EPSG geodetic dataset defines geographic Coordinate Reference Systems that way.
@@ -242,7 +243,7 @@ GeodeticCRS["WGS 84",
Unit["degree", 0.017453292519943295]]
{{< / highlight >}}
-If (_longitude_, _latitude_) axis order is really wanted, Apache SIS can be forced to that order [as described above](#axisOrder).
+If (_longitude_, _latitude_) axis order is really wanted, Apache {{% SIS %}} can be forced to that order [as described above](#axisOrder).
### I have correct axis order but my transformed coordinates are still wrong. {#projectionName}
@@ -256,12 +257,13 @@ ESRI also defines a _"Stereographic"_ projection, which is actually an oblique p
### I just used the WKT of a well-known authority and my transformed coordinates are still wrong! {#parameterUnits}
-The Well Known Text (WKT) specification has been interpreted in different ways by different implementors.
+The version 1 of Well Known Text (WKT) specification has been interpreted in different ways by different implementors.
One subtle issue is the angular units of prime meridian and projection parameter values.
-The WKT 1 specification clary states: _"If the `PRIMEM` clause occurs inside a `GEOGCS`,
+The {{% WKT %}} 1 specification clary states: _"If the `PRIMEM` clause occurs inside a `GEOGCS`,
then the longitude units will match those of the geographic coordinate system"_ (source: {{% OGC %}} 01-009).
-However ESRI and GDAL among others unconditionally use decimal degrees, ignoring this part of the WKT specification.
-This problem can be identified by WKT inspection as in the following extract:
+However ESRI and GDAL among others unconditionally use decimal degrees, ignoring this part of the {{% WKT %}} 1 specification
+(note: this remark does not apply to {{% WKT %}} 2).
+This problem can be identified by {{% WKT %}} inspection as in the following extract:
{{< highlight text >}}
PROJCS["Lambert II étendu",
@@ -273,20 +275,20 @@ PROJCS["Lambert II étendu",
{{< / highlight >}}
The Paris prime meridian is located at approximatively 2.597 gradians from Greenwich, which is 2.337 degrees.
-From this fact, we can see that the above WKT uses decimal degrees despite its `UNIT["grad"]` declaration.
+From this fact, we can see that the above {{% WKT %}} uses decimal degrees despite its `UNIT["grad"]` declaration.
This mismatch applies also to the parameter value, which declare 46.8° in the above example while the official value is 52 gradians.
-By default, Apache SIS interprets those angular values as gradians when parsing such WKT, resulting in a large error.
+By default, Apache {{% SIS %}} interprets those angular values as gradians when parsing such {{% WKT %}}, resulting in a large error.
In order to get the intended result, there is a choice:
* Replace `UNIT["grad", 0.01570796326794897]` by `UNIT["degree", 0.017453292519943295]`,
- which ensure that Apache SIS, GDAL and ESRI understand that WKT in the same way.
+ which ensure that Apache {{% SIS %}}, GDAL and ESRI understand that {{% WKT %}} 1 in the same way.
-* Or ask explicitely Apache SIS to parse the WKT using the ESRI or GDAL conventions, by specifying the
- `Convention.WKT1_COMMON_UNITS` enumeration value to `WKTFormat` in the `org.apache.sis.io.wkt` package.
+* Or ask explicitely Apache {{% SIS %}} to parse the {{% WKT %}} using the ESRI or GDAL conventions, by specifying the
+ `Convention.WKT1_COMMON_UNITS` enumeration value to `WKTFormat` in the `org.apache.sis.io.wkt` package.
-Note that the GeoPackage standard explicitely requires {{% OGC %}} 01-009 compliant WKT
-and the new WKT 2 standard also follows the {{% OGC %}} 01-009 interpretation.
-The default Apache SIS behavior is consistent with those two standards.
+Note that the GeoPackage standard explicitely requires {{% OGC %}} 01-009 compliant {{% WKT %}}
+and the new {{% WKT %}} 2 standard also follows the {{% OGC %}} 01-009 interpretation.
+The default Apache {{% SIS %}} behavior is consistent with those two standards.
### I verified all the above and still have an error of about one kilometer. {#BursaWolf}
@@ -298,8 +300,8 @@ But when the transformation involves a change of datum, the referencing module n
There is many way to specify how to perform a datum shift, and most of them are only approximation.
The Bursa-Wolf method is one of them, not the only one. However it is one of the most frequently used methods.
The Bursa-Wolf parameters can be specified inside a `TOWGS84` element with version 1 of Well Known Text (WKT) format,
-or in a `BOUNDCRS` element with version 2 of WKT format.
-If the CRS are parsed from a WKT string, make sure that the string contains the appropriate element.
+or in a `BOUNDCRS` element with version 2 of {{% WKT %}} format.
+If the CRS are parsed from a {{% WKT %}} string, make sure that the string contains the appropriate element.
### I get slightly different results depending on the environment I’m running in. {#slightDifferences}
@@ -319,9 +321,9 @@ Make sure that the [connection parameters to the EPSG database](epsg.html) are a
### Can I always expect a transform from an arbitrary CRS to WGS84 to succeed? {#toWGS84}
-For 2D horizontal {{% CRS %}} created from the EPSG database, calls to `CRS.findOperation(...)` should generally succeed.
+For 2D horizontal {{% CRS %}} created from the EPSG database, calls to `CRS.findOperation(…)` should generally succeed.
For 3D {{% CRS %}} having any kind of height different than ellipsoidal height, or for a 2D {{% CRS %}} of type `EngineeringCRS`, it may fail.
-Note however that even if the call to `CRS.findOperation(...)` succeed, the call to `MathTransform.transform(...)` may fail
+Note however that even if the call to `CRS.findOperation(…)` succeed, the call to `MathTransform.transform(…)` may fail
or produce `NaN` or infinity values if the coordinate to transform is far from the domain of validity.
# Metadata {#metadata}
diff --git a/source/faq_fr.md b/source/faq_fr.md
index 4837b3f..d0f59f0 100644
--- a/source/faq_fr.md
+++ b/source/faq_fr.md
@@ -2,7 +2,7 @@
title: Questions fréquentes (FAQ)
---
-Cette page liste quelques questions fréquemment posées à propos de Apache SIS.
+Cette page liste quelques questions fréquemment posées à propos de Apache {{% SIS %}}.
Son contenu est traduit de la [page de FAQ en anglais](faq.html).
{{< toc >}}
@@ -49,7 +49,7 @@ public class MyApp {
### Quelles projections sont supportées ? {#operation-methods}
-Les formules supportées par Apache SIS (incluant les projections cartographiques, mais pas uniquement)
+Les formules supportées par Apache {{% SIS %}} (incluant les projections cartographiques, mais pas uniquement)
sont listées sur la page [Coordinate Operation Methods](tables/CoordinateOperationMethods.html).
La quantité de formules de projection est relativement faible,
mais la quantité de _Systèmes de Coordonées projetés_ que l’on peut construire avec est considérable.
@@ -59,7 +59,7 @@ utilisées avec différents paramètres, on peut couvrir des milliers de project
Afin d’utiliser une formule de projection, il est nécessaire de connaître les paramètres de la projection.
Par soucis de facilité d’utilisation, des milliers de projections avec des paramètres pré-définis ont un identifiant unique.
Une source bien connue de ces définitions est la base de données EPSG, mais il existe d’autres autorités.
-Les systèmes de coordonnées prédéfinis dans Apache SIS sont listés à la page
+Les systèmes de coordonnées prédéfinis dans Apache {{% SIS %}} sont listés à la page
[Coordinate Reference Systems](tables/CoordinateReferenceSystems.html).
### Qu’est ce que le problème d’ordre des axes et comment est il abordé ? {#axisOrder}
@@ -83,13 +83,13 @@ Les standards {{% OGC %}} récents stipulent que l’ordre des axes est celui d
Les standards {{% OGC %}} plus anciens utilisaient l’ordre des axes (_x_, _y_), ignorant la définition de l’autorité.
Parmi les standards {{% OGC %}} obsolètes qui utilisent un ordre des axes non-conforme,
l’un des plus influent est la version 1 de la spécification _Well Known Text_ (WKT).
-Selon ce format très utilisé, les définitions WKT sans éléments `AXIS[...]`
+Selon ce format très utilisé, les définitions {{% WKT %}} sans éléments `AXIS[…]`
doivent par défaut être dans l’ordre (_longitude_, _latitude_) ou (_x_, _y_).
-Dans la version 2 du format WKT, les éléments `AXIS[...]` ne sont plus optionnels
-et doivent contenir explicitement le sous-élément `ORDER[...]` pour appuyer l’ordre des axes à appliquer.
+Dans la version 2 du format {{% WKT %}}, les éléments `AXIS[…]` ne sont plus optionnels
+et doivent contenir explicitement le sous-élément `ORDER[…]` pour appuyer l’ordre des axes à appliquer.
Beaucoup de logiciels utilisent toujours l’ancien ordre des axes (_x_, _y_), parfois parce qu’il est plus simple à implémenter.
-Mais Apache SIS suit l’ordre des axes _tel que défini par l’autorité_ (à l’exception de la lecture de fichier WKT 1).
+Mais Apache {{% SIS %}} suit l’ordre des axes _tel que défini par l’autorité_ (à l’exception de la lecture de fichier {{% WKT %}} 1).
Il permet toutefois de changer l’ordre des axes après la création d’un {{% CRS %}}.
Ce changement se fait avec le code suivant :
@@ -102,7 +102,7 @@ crs = AbstractCRS.castOrCopy(crs).forConvention(AxesConvention.RIGHT_HANDED)
### Comment créer une projection de type Transverse Universelle de Mercator (UTM) ? {#UTM}
-Si la zone UTM n’est pas connue, une façon simple est d’utiliser la méthode `universal(...)` sur l’une des constantes de `CommonCRS`.
+Si la zone UTM n’est pas connue, une façon simple est d’utiliser la méthode `universal(…)` sur l’une des constantes de `CommonCRS`.
Cette méthode prend en argument une coordonnées géographique en (_latitude_, _longitude_) et en calcule la zone UTM correspondante.
Voir [le code java ci-dessus](#transform-point).
@@ -140,8 +140,8 @@ Ces méthodes ont le mot « (Spherical) » dans leur nom, par exemple _« Mer
Ces formules de projections peuvent être utilisées dans les définitions _Well Known Text_ (WKT).
Il est possible d’utiliser une formule sphérique avec une projection qui n’a pas de contrepartie sphérique
-en déclarant explicitement les paramètres `"semi_major"` et `"semi_minor"` dans la définition WKT.
-Ces paramètres sont généralement déduit du référentiel, mais Apache SIS autorise les déclarations à surcharger ces valeurs.
+en déclarant explicitement les paramètres `"semi_major"` et `"semi_minor"` dans la définition {{% WKT %}}.
+Ces paramètres sont généralement déduit du référentiel, mais Apache {{% SIS %}} autorise les déclarations à surcharger ces valeurs.
### Comment puis-je identifier le type de projection d’un CRS ? {#projectionKind}
@@ -154,17 +154,18 @@ listés à la page [Coordinate Operation Methods](tables/CoordinateOperationMeth
La propriété _identifiant_ d’un {{% CRS %}} peut être obtenue par la méthode `getIdentifiers()`
qui retourne une collection de zéro ou un élément.
Si le {{% CRS %}} a été créé à partir d’un _Well Known Text_ (WKT)
-et que le WKT se termine avec un élément `AUTHORITY["EPSG", "xxxx"]` (WKT version 1) ou `ID["EPSG", xxxx]` (WKT version 2,
+et que le {{% WKT %}} se termine avec un élément `AUTHORITY["EPSG", "xxxx"]` ({{% WKT %}} version 1)
+ou `ID["EPSG", xxxx]` ({{% WKT %}} version 2,
alors l’identifiant (un code numérique EPSG dans cet exemple) sera le _xxxx_ de cet élément.
Si le {{% CRS %}} a été créé à partir de la base EPSG (par exemple avec l’appelle à `CRS.forCode("EPSG:xxxx")`),
alors l’identifiant est le code _xxxx_ donné à la méthode.
Si le {{% CRS %}} a été créé d’une autre façon, alors la collection retournée par la méthode `getIdentifiers()`
pourra être vide dans le cas où le programme qui a créé le {{% CRS %}} a aussi pris la responsabilité de fournir les identifiants.
-Si la collection d’identifiants est vide, la méthode la plus efficace de le corriger est de s’assurer que le WKT
-contient un élément `AUTHORITY` ou `ID` (en supposant que le {{% CRS %}} vient d’un WKT).
-Si ce n’est pas possible, alors la classe `org.apache.sis.referencing.IdentifiedObjects` contient des méthodes utilitaires qui peuvent aider
-Dans l’exemple suivant, l’appel à `lookupEPSG(...)` va parcourir la base EPSG pour un {{% CRS %}} équivalent (en ignorant les métadonnées).
+Si la collection d’identifiants est vide, la méthode la plus efficace de le corriger est de s’assurer que le {{% WKT %}}
+contient un élément `AUTHORITY` ou `ID` (en supposant que le {{% CRS %}} vient d’un {{% WKT %}}).
+Si ce n’est pas possible, alors la classe `org.apache.sis.referencing.IdentifiedObjects` contient des méthodes utilitaires qui peuvent aider
+Dans l’exemple suivant, l’appel à `lookupEPSG(…)` va parcourir la base EPSG pour un {{% CRS %}} équivalent (en ignorant les métadonnées).
*Attention, cette recherche est sensible à l’ordre des axes.*
La plupart des {{% CRS %}} géographiques de la base EPSG sont déclarés avec l’ordre des axes (_latitude_, _longitude_).
En conséquence, si le {{% CRS %}} possède un ordre des axes (_longitude_, _latitude_), la recherche a toutes les chances de ne pas trouver de résultats.
@@ -177,7 +178,7 @@ if (identifier != null) {
}
{{< / highlight >}}
-### Comment obtenir l’URN « urn:ogc:def:crs:... » d’un CRS existant ? {#lookupURN}
+### Comment obtenir l’URN « urn:ogc:def:crs:… » d’un CRS existant ? {#lookupURN}
L’{{% OGC %}} définit les URN pour les identifiants de {{% CRS %}}, par exemple `"urn:ogc:def:crs:epsg:7.1:4326"`
avec `"7.1"` comme version de la base EPSG utilisée.
@@ -191,13 +192,13 @@ CoordinateReferenceSystem myCRS = ...;
String urn = IdentifiedObjects.lookupURN(myCRS);
{{< / highlight >}}
-### Puis-je m’appuyer sur IdentifiedObjects.lookupEPSG(...) comme inverse de CRS.forCode(...) ? {#lookupReliability}
+### Puis-je m’appuyer sur IdentifiedObjects.lookupEPSG(…) comme inverse de CRS.forCode(…) ? {#lookupReliability}
Pour les {{% CRS %}} créés avec la base EPSG, en général oui.
-À noter toutefois que `IdentifiedObjects.getIdentifier(...)` est moins riche et insensible aux détails de la définition du {{% CRS %}}
+À noter toutefois que `IdentifiedObjects.getIdentifier(…)` est moins riche et insensible aux détails de la définition du {{% CRS %}}
car il n’interroge pas la base de données EPSG. Il marche uniquement si le {{% CRS %}} déclare explicitement son code
ce qui est le cas des {{% CRS %}} créés à partir de la base EPSG ou lus à partir d’un _Well Known Text_ (WKT) avec un élément `AUTHORITY` ou `ID`.
-La méthode `lookupEPSG(...)` à l’inverse est plus robuste contre les erreurs de déclaration de code car elle compare toujours le {{% CRS %}} avec celui de la base.
+La méthode `lookupEPSG(…)` à l’inverse est plus robuste contre les erreurs de déclaration de code car elle compare toujours le {{% CRS %}} avec celui de la base.
Elle peut échouer s’il y a une légère différence (par exemple d’arrondie dans les paramètres)
entre le {{% CRS %}} fourni et le {{% CRS %}} trouvé dans la base de données.
@@ -211,7 +212,7 @@ Afin de tester si deux {{% CRS %}} sont fonctionnellement équivalents, utilisez
Oui, toutes les classes définies dans les paquets `org.apache.sis.referencing.crs`, `cs` et `datum`
définissent leurs propres méthodes `equals(Object)` et `hashCode()`.
-La bibliothèque Apache SIS utilise elle-même les objets {{% CRS %}} dans des `Map` à des fins de cache.
+La bibliothèque Apache {{% SIS %}} utilise elle-même les objets {{% CRS %}} dans des `Map` à des fins de cache.
## Transformation de coordonnées {#transforms}
@@ -242,7 +243,7 @@ GeodeticCRS["WGS 84",
Unit["degree", 0.017453292519943295]]
{{< / highlight >}}
-Si l’ordre (_longitude_, _latitude_) est voulu, Apache SIS est capable de le forcer comme décrit [ci-dessus](#axisOrder).
+Si l’ordre (_longitude_, _latitude_) est voulu, Apache {{% SIS %}} est capable de le forcer comme décrit [ci-dessus](#axisOrder).
### Les ordres des axes sont corrects mais les coordonnées transformées sont encore fausses. {#projectionName}
@@ -256,12 +257,13 @@ ESRI définit aussi une projection _« Stereographic »_ qui est en réalité
### J’ai juste utilisé le WKT d’une autorité connue et mes coordonnées transformées sont toujours fausses ! {#parameterUnits}
-La spécification _Well Known Text_ (WKT) a été interprétée de différentes façons en fonction des implémentations logicielles.
+La version 1 de la spécification _Well Known Text_ (WKT) a été interprétée de différentes façons en fonction des implémentations logicielles.
Un problème subtil vient des unités d’angles pour le méridien d’origine et les paramètres de projection.
-La spécification WKT 1 stipule clairement : _« Si l’élément `PRIMEM` apparaît dans `GEOGCS`,
+La spécification {{% WKT %}} 1 stipule clairement : _« Si l’élément `PRIMEM` apparaît dans `GEOGCS`,
alors l’unité des longitudes doit correspondre à celle du système de coordonnées géographiques »_ (traduction libre de {{% OGC %}} 01-009).
-Toutefois ESRI et GDAL entres autres utilisent inconditionnellement des degrés décimaux, ignorant cette partie de la spécification WKT.
-Ce problème peut être identifié en inspectant l’extrait de WKT suivant :
+Toutefois ESRI et GDAL entres autres utilisent inconditionnellement des degrés décimaux, ignorant cette partie de la spécification {{% WKT %}} 1
+(note: cette remarque ne s’applique pas à {{% WKT %}} 2).
+Ce problème peut être identifié en inspectant l’extrait de {{% WKT %}} suivant :
{{< highlight text >}}
PROJCS["Lambert II étendu",
@@ -273,20 +275,20 @@ PROJCS["Lambert II étendu",
{{< / highlight >}}
Le méridien d’origine de Paris est situé à approximativement 2,597 gradians de Greenwich, ce qui correspond à 2,337 degrés.
-À partir de ce fait, on peut voir que le WKT ci-dessus utilise des degrés malgré la déclaration de l’unité `UNIT["grad"]`.
+À partir de ce fait, on peut voir que le {{% WKT %}} ci-dessus utilise des degrés malgré la déclaration de l’unité `UNIT["grad"]`.
Cette erreur s’applique aussi aux valeurs des paramètres, qui déclarent 46,8° dans l’exemple ci-dessus alors que la valeur officielle est de 52 gradians.
-Par défaut, Apache SIS interprète ces valeurs angulaires en gradians quand il lit ce type de WKT, ce qui produit de grandes erreurs.
+Par défaut, Apache {{% SIS %}} interprète ces valeurs angulaires en gradians quand il lit ce type de {{% WKT %}}, ce qui produit de grandes erreurs.
Afin d’obtenir le résultat attendu, il est possible de :
* Remplacer `UNIT["grad", 0.01570796326794897]` par `UNIT["degree", 0.017453292519943295]`,
- ce qui va assurer que Apache SIS, GDAL et ESRI comprennent ce WKT de la même manière.
+ ce qui va assurer que Apache {{% SIS %}}, GDAL et ESRI comprennent ce {{% WKT %}} 1 de la même manière.
-* Ou demander explicitement à Apache SIS de lire le WKT en utilisant les conventions ESRI ou GDAL,
- avec l’énumération `Convention.WKT1_COMMON_UNITS` pour la valeur de `WKTFormat` dans le paquet `org.apache.sis.io.wkt`.
+* Ou demander explicitement à Apache {{% SIS %}} de lire le {{% WKT %}} en utilisant les conventions ESRI ou GDAL,
+ avec l’énumération `Convention.WKT1_COMMON_UNITS` pour la valeur de `WKTFormat` dans le paquet `org.apache.sis.io.wkt`.
Il est à noter que le standard GeoPackage requiert explicitement la conformité avec {{% OGC %}} 01-009
-et que le nouveau standard WKT 2 suit aussi l’interprétation de {{% OGC %}} 01-009.
-Le comportement par défaut de Apache SIS est cohérent avec ces deux standards.
+et que le nouveau standard {{% WKT %}} 2 suit aussi l’interprétation de {{% OGC %}} 01-009.
+Le comportement par défaut de Apache {{% SIS %}} est cohérent avec ces deux standards.
### J’ai vérifié tous ce qui est ci-dessus et j’ai toujours une erreur d’environ un kilomètre. {#BursaWolf}
@@ -298,8 +300,8 @@ Mais quand la transformation implique un changement de référentiel, le module
Il y a plusieurs façon de spécifier comment appliquer un changement de référentiel, et la plupart sont seulement approximatives.
La méthode de Bursa-Wolf est l’une d’elle, mais pas la seule. Toutefois elle est une des plus fréquemment utilisées.
Les paramètres Bursa-Wolf peuvent être spécifiés à l’intérieur de l’élément `TOWGS84` de la version 1 du format _Well Known Text_ (WKT),
-ou dans l’élément `BOUNDCRS` avec la version 2 du format WKT.
-Si le {{% CRS %}} est lu à partir d’une chaine WKT, assurez-vous qu’elle contient l’élément approprié.
+ou dans l’élément `BOUNDCRS` avec la version 2 du format {{% WKT %}}.
+Si le {{% CRS %}} est lu à partir d’une chaine {{% WKT %}}, assurez-vous qu’elle contient l’élément approprié.
### J’obtiens des résultats légèrement différents d’un environnement d’exécution à l’autre. {#slightDifferences}
@@ -319,9 +321,9 @@ Assurez vous également que les [paramètres de connexion à la base EPSG](epsg.
### Puis-je présumer qu’il est toujours possible de transformer un CRS arbitraire vers WGS84 ? {#toWGS84}
-Pour les {{% CRS %}} 2D horizontaux créés avec la base de données EPSG, l’appel à `CRS.findOperation(...)` devrait toujours marcher.
+Pour les {{% CRS %}} 2D horizontaux créés avec la base de données EPSG, l’appel à `CRS.findOperation(…)` devrait toujours marcher.
Pour les {{% CRS %}} 3D ayant n’importe quel axe de hauteur autre que la hauteur ellipsoïdale, ou pour les {{% CRS %}} 2D de type `EngineeringCRS`, la méthode peu échouer.
-Il reste à noter que dans le cas ou la méthode `CRS.findOperation(...)` ne lève pas d’erreur, l’appel à `MathTransform.transform(...)` peut
+Il reste à noter que dans le cas ou la méthode `CRS.findOperation(…)` ne lève pas d’erreur, l’appel à `MathTransform.transform(…)` peut
produire des valeurs `NaN` or `Infinity`si la coordonnée transformée est éloignée de la zone de validité.
# Métadonnées {#metadata}
diff --git a/source/mail-lists.md b/source/mail-lists.md
index 7937603..877ca63 100644
--- a/source/mail-lists.md
+++ b/source/mail-lists.md
@@ -2,58 +2,68 @@
title: Mailing lists
---
-We welcome you to join mailing lists and let us know about your thoughts or ideas about Apache SIS.
+We welcome you to join mailing lists and let us know about your thoughts or ideas about Apache {{% SIS %}}.
Everyone can subscribe, but note that all emails sent to those lists are archived and publicly readable on the web.
See [Public Forum Archive Policy][policy] for more information.
-## Geospatial Mailing List {#geospatial}
+{{< toc >}}
-This is where peoples can ask questions or discuss about geospatial topics that are not specific to Apache SIS.
+
+# Cross-project mailing lists
+
+## Geospatial mailing list {#geospatial}
+
+This is where peoples can ask questions or discuss about geospatial topics that are not specific to Apache {{% SIS %}}.
Those topics can include questions about international standards, participation to upcomming geospatial events
or collaboration with communities outside Apache.
-- Subscribe: [geospatial-subscribe@apache.org][geo-sub]
+- Subscribe: [geospatial-subscribe@apache.org][geo-sub]
- Post (after subscription): [geospatial@apache.org][geo-post]
- Unsubscribe: [geospatial-unsubscribe@apache.org][geo-unsub]
-- Archives:
- - [Pony mail][geo-pony-arch]
+- Archives: [Pony mail][geo-pony-arch]
+
-## Apache SIS User Mailing List {#user}
+# Apache SIS mailing lists
+
+## User mailing list {#user}
This is where users can ask questions about how to use SIS.
-- Subscribe: [user-subscribe@sis.apache.org][usr-sub]
+- Subscribe: [user-subscribe@sis.apache.org][usr-sub]
- Post (after subscription): [user@sis.apache.org][usr-post]
- Unsubscribe: [user-unsubscribe@sis.apache.org][usr-unsub]
-- Archives:
- - [Pony mail][usr-pony-arch]
- - [Apache][usr-arch]
+- Archives: [Pony mail][usr-pony-arch] or [Apache][usr-arch]
-## Apache SIS Developer Mailing List {#developer}
+## Developer mailing list {#developer}
This is where the community hangs out and SIS development happens.
-- Subscribe: [dev-subscribe@sis.apache.org][dev-sub]
+- Subscribe: [dev-subscribe@sis.apache.org][dev-sub]
- Post (after subscription): [dev@sis.apache.org][dev-post]
- Unsubscribe: [dev-unsubscribe@sis.apache.org][dev-unsub]
-- Archives:
- - [Pony mail][dev-pony-arch]
- - [Apache][dev-arch]
+- Archives: [Pony mail][dev-pony-arch] or [Apache][dev-arch]
+
+## Issues mailing list {#issues}
+
+This is where changes on JIRA issues are reported.
+
+- Subscribe: [issues-subscribe@sis.apache.org][iss-sub]
+- Unsubscribe: [issues-unsubscribe@sis.apache.org][iss-unsub]
+- Archives: [Pony mail][iss-pony-arch]
-## Apache SIS Commit Mailing List {#commit}
+## Commit mailing list {#commit}
This is where the community receives automated notifications of
any changes to the sis code and documentation.
-- Subscribe: [commits-subscribe@sis.apache.org][com-sub]
-- Unsubscribe: [commmits-unsubscribe@sis.apache.org][com-unsub]
-- Archives:
- - [Pony mail][com-pony-arch]
- - [Apache][com-arch]
+- Subscribe: [commits-subscribe@sis.apache.org][com-sub]
+- Unsubscribe: [commits-unsubscribe@sis.apache.org][com-unsub]
+- Archives: [Pony mail][com-pony-arch] or [Apache][com-arch]
[geo-sub]: mailto:geospatial-subscribe@apache.org
[usr-sub]: mailto:user-subscribe@sis.apache.org
[dev-sub]: mailto:dev-subscribe@sis.apache.org
+[iss-sub]: mailto:issues-subscribe@sis.apache.org
[com-sub]: mailto:commits-subscribe@sis.apache.org
[geo-post]: mailto:geospatial@apache.org
[usr-post]: mailto:user@sis.apache.org
@@ -61,6 +71,7 @@ any changes to the sis code and documentation.
[geo-unsub]: mailto:geospatial-unsubscribe@apache.org
[usr-unsub]: mailto:user-unsubscribe@sis.apache.org
[dev-unsub]: mailto:dev-unsubscribe@sis.apache.org
+[iss-unsub]: mailto:issues-unsubscribe@sis.apache.org
[com-unsub]: mailto:commits-unsubscribe@sis.apache.org
[usr-arch]: http://mail-archives.apache.org/mod_mbox/sis-user/
[dev-arch]: http://mail-archives.apache.org/mod_mbox/sis-dev/
@@ -68,5 +79,6 @@ any changes to the sis code and documentation.
[geo-pony-arch]: https://lists.apache.org/list.html?geospatial@apache.org
[usr-pony-arch]: https://lists.apache.org/list.html?user@sis.apache.org
[dev-pony-arch]: https://lists.apache.org/list.html?dev@sis.apache.org
+[iss-pony-arch]: https://lists.apache.org/list.html?issues@sis.apache.org
[com-pony-arch]: https://lists.apache.org/list.html?commits@sis.apache.org
[policy]: http://www.apache.org/foundation/public-archives.html
diff --git a/source/release-management.md b/source/release-management.md
index ac9d451..9313ffb 100644
--- a/source/release-management.md
+++ b/source/release-management.md
@@ -24,7 +24,7 @@ the current release attempt. Those versions shall be set on the command line lik
{{< highlight bash >}}
gpg --list-keys # For getting the value to put in <your key ID>
unset PATH_TO_FX
-export OLD_VERSION=1.1
+export OLD_VERSION={{% version %}}
export NEW_VERSION=1.2
export RELEASE_CANDIDATE=1
export SIGNING_KEY=<your key ID> # hexadecimal number with 8 or 40 digits.
@@ -249,7 +249,7 @@ If above verifications succeeded, performs the following _temporary_ changes
This hack will force us to skip test compilations.
Then deploy SIS (without test JAR files).
-Deploy also the non-free resources in a staging repository separated from the rest of Apache SIS.
+Deploy also the non-free resources in a staging repository separated from the rest of Apache {{% SIS %}}.
If there is any issue with this deployment, the staging repository can easily be dropped and recreated.
{{< highlight bash >}}
@@ -309,7 +309,7 @@ mvn compile
svn commit -m "Test project for SIS $NEW_VERSION-RC$RELEASE_CANDIDATE"
{{< / highlight >}}
-Create a temporary directory where Apache SIS will write the EPSG dataset.
+Create a temporary directory where Apache {{% SIS %}} will write the EPSG dataset.
{{< highlight bash >}}
mkdir target/SpatialMetadata
diff --git a/source/source.md b/source/source.md
index 26a080f..25e1915 100644
--- a/source/source.md
+++ b/source/source.md
@@ -2,11 +2,11 @@
title: Checkout source code
---
-Apache SIS source code is maintained using [Git][git] version control,
+Apache {{% SIS %}} source code is maintained using [Git][git] version control,
completed by optional data maintained using [Subversion][subversion] version control.
Optional data include in particular the [EPSG geodetic dataset][epsg-install],
which is subject to licensing terms different than Apache ones.
-This page describes two ways to checkout Apache SIS source code:
+This page describes two ways to checkout Apache {{% SIS %}} source code:
* A basic checkout with only the main repository, the most stable branch, and no configuration requirement.
* A more advanced configuration for active SIS developments, using uncommitted (for now) API
@@ -19,10 +19,10 @@ or to cherry-pick only the interesting parts of the advanced configuration.
# Basic installation {#basic}
-Create an empty directory for the Apache SIS project.
+Create an empty directory for the Apache {{% SIS %}} project.
We use `ApacheSIS` directory name in this page, but that name can be anything;
replace that name in the shell commands below if another name is used.
-The Apache SIS source code can be cloned in that directory as below
+The Apache {{% SIS %}} source code can be cloned in that directory as below
(lines starting with `#` are comments and can be ignored):
{{< highlight bash >}}
@@ -37,7 +37,7 @@ git clone https://gitbox.apache.org/repos/asf/sis
# svn checkout https://github.com/apache/sis/trunk
{{< / highlight >}}
-That is all. Apache SIS can be built by running `mvn install` in the `sis` subdirectory.
+That is all. Apache {{% SIS %}} can be built by running `mvn install` in the `sis` subdirectory.
At this stage, the `ApacheSIS` parent directory is redundant with the `sis` subdirectory,
but we recommend to create that parent directory anyway in anticipation
for more subdirectories to be created later, when desired.
@@ -52,7 +52,7 @@ because some other optional services depend on it.
## Create data directory {#data}
-Apache SIS needs a directory where to store database, datum shift files and other optional data.
+Apache {{% SIS %}} needs a directory where to store database, datum shift files and other optional data.
That directory is specified by the `SIS_DATA` environment variable and can be located anywhere.
A convenient location is a subdirectory of the `ApacheSIS` directory created in the "basic checkout" section.
For example (with `ApacheSIS` as the current directory):
@@ -74,7 +74,7 @@ The EPSG geodetic dataset is recommended for operations related to Coordinate Re
Without the EPSG database, only a [small subset](apidocs/org/apache/sis/referencing/CRS.html#forCode-java.lang.String-)
of coordinate reference systems can be created from EPSG codes.
The EPSG database can be [installed in various ways][epsg-install],
-but this section describes an alternative way more suitable to Apache SIS development.
+but this section describes an alternative way more suitable to Apache {{% SIS %}} development.
Before to continue, make sure to agree with [EPSG terms of use][EPSG-ToU].
Then following command can be executed with `ApacheSIS` as the current directory:
@@ -83,7 +83,7 @@ Then following command can be executed with `ApacheSIS` as the current directory
svn checkout https://svn.apache.org/repos/asf/sis/data/non-free/
{{< / highlight >}}
-Then copy or link the EPSG scripts in the directory where Apache SIS looks for optional data.
+Then copy or link the EPSG scripts in the directory where Apache {{% SIS %}} looks for optional data.
Adjust the relative paths as needed if the `SIS_DATA` environment variable
points to another location than the one used in above section:
@@ -97,17 +97,17 @@ ln -s ../../../non-free/sis-epsg/src/main/resources/org/apache/sis/referencing/f
cd -
{{< / highlight >}}
-This is sufficient for allowing Apache SIS to create the geodetic database
+This is sufficient for allowing Apache {{% SIS %}} to create the geodetic database
without the need for `sis-epsg` or `sis-embedded-data` module on the classpath.
This setting is not done automatically because Apache projects can not introduce
non-free dependencies without explicit action from user.
If this action is not taken, some JUnit tests requiring EPSG data may be skipped.
If any EPSG file is updated, deleting the `$SIS_DATA/Databases/SpatialMetadata` directory
-is sufficient for causing Apache SIS to recreate the Derby database with new data.
+is sufficient for causing Apache {{% SIS %}} to recreate the Derby database with new data.
## Configure PostgreSQL {#postgres}
-Apache SIS is tested with Derby, HSQL and PostgreSQL databases.
+Apache {{% SIS %}} is tested with Derby, HSQL and PostgreSQL databases.
Derby and HSQL are tested automatically using temporary databases in memory.
But testing on PostgreSQL requires the creation of a dedicated database on the developer platform.
The requirements are:
@@ -119,7 +119,7 @@ The requirements are:
* `org.apache.sis.test.extensive` Java property set to `true`.
The `SpatialMetadataTest` database should stay empty when not running tests,
-because Apache SIS always delete the temporary schema after tests completion,
+because Apache {{% SIS %}} always delete the temporary schema after tests completion,
regardless if the tests were successful or not.
The role and database can be created by the following SQL instructions
(replace `my_unix_user_name` by your actual user name):
@@ -140,15 +140,15 @@ Location of this file is system-dependent; it may be `/var/lib/pgsql/da
host SpatialMetadataTest my_unix_user_name 127.0.0.1/32 trust
{{< / highlight >}}
-The last step for allowing Apache SIS to run tests on PostgreSQL is to set the
+The last step for allowing Apache {{% SIS %}} to run tests on PostgreSQL is to set the
`org.apache.sis.test.extensive` Java property to `true` (see next section).
This requirement has been added for avoiding undesired interference with host.
-Note that this step is likely to change after Apache SIS upgrade to JUnit 5.
+Note that this step is likely to change after Apache {{% SIS %}} upgrade to JUnit 5.
## Running extensive tests {#tests}
A simple `mvn install` execution in the `sis` directory
-will build and test Apache SIS with the default set of JUnit tests.
+will build and test Apache {{% SIS %}} with the default set of JUnit tests.
Some tests are skipped by default, either because they would have some effects outside
the `sis` directory (for example writing in `SpatialMetadataTest` database on PostgreSQL),
or because those tests take a long time to execute.
@@ -162,7 +162,7 @@ mvn install -Dorg.apache.sis.test.extensive=true
## Switch to development branch {#branches}
The source code repository contains `master`, `geoapi-3.1` and `geoapi-4.0` branches.
-Apache SIS releases are created from `master`, which depends on the latest GeoAPI version
+Apache {{% SIS %}} releases are created from `master`, which depends on the latest GeoAPI version
released by the Open Geospatial Consortium (OGC), currently [GeoAPI 3.0.1][geoapi-stable].
However daily developments occur on the `geoapi-4.0` branch before to be merged (indirectly) to `master`.
Those branches exist in order to experiment early new API and technologies — since they may impact
@@ -175,7 +175,7 @@ In summary:
Developments on `geoapi-4.0` branch are merged to `geoapi-3.1` branch, which is then merged to `master`.
When commits reach `master` they become unmodifiable; the `git push --force` command is not allowed on that branch.
-Contributors to Apache SIS project should switch to the current development branch before submitting patches:
+Contributors to Apache {{% SIS %}} project should switch to the current development branch before submitting patches:
{{< highlight bash >}}
cd sis
@@ -187,9 +187,9 @@ after {{% OGC %}} releases the corresponding GeoAPI versions.
# Opening Apache SIS in NetBeans {#netbeans}
-Apache SIS build is defined by Maven `pom.xml` files.
+Apache {{% SIS %}} build is defined by Maven `pom.xml` files.
All major IDE, including NetBeans, can open a project defined by those files.
-However in the particular case of NetBeans IDE, we also provide a way to open Apache SIS using Ant configuration files.
+However in the particular case of NetBeans IDE, we also provide a way to open Apache {{% SIS %}} using Ant configuration files.
Compared to "Java with Maven" project, the "Java with Ant" project is faster to build and debug,
makes easier to see all modules at once, and provides more configuration options.
Those configuration files are available in the `ide-project/NetBeans` directory.
@@ -210,9 +210,9 @@ run.jvmargs = -DmyProperty=myValue
# History {#history}
-All developments and tags prior Apache SIS 1.0 were done on a [Subversion][subversion] repository
+All developments and tags prior Apache {{% SIS %}} 1.0 were done on a [Subversion][subversion] repository
and can be [browsed online][viewvc].
-Tags for Apache SIS versions 0.1 to 0.8 should be fetched from the [SVN repository][svn-sis-tags].
+Tags for Apache {{% SIS %}} versions 0.1 to 0.8 should be fetched from the [SVN repository][svn-sis-tags].
The development branches on that repository were named `JDK8`, `JDK7`, `JDK6` and `trunk`.
[subversion]: http://subversion.apache.org
diff --git a/static/css/sis.css b/static/css/sis.css
index cd9eaa0..ee672bc 100644
--- a/static/css/sis.css
+++ b/static/css/sis.css
@@ -37,6 +37,9 @@ main a {
text-decoration: none;
color: #1f618d;
}
+main abbr[title] {
+ text-decoration: none;
+}
pre, code {
/* Avoid Monaco font, since box (or tree) symbols do not render well. */
font-family: Menlo,Consolas,"Courier New",monospace;
@@ -85,5 +88,6 @@ main table tr td {
text-align: center;
}
.footer a {
+ text-decoration: none;
color: gray;
}
[sis-site] 01/03: Set the sidebar at a fixed position.
Posted by de...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sis-site.git
commit 993bef3dacb460a787f8ba04c0c5d4c9c2e217c7
Author: Martin Desruisseaux <ma...@geomatys.com>
AuthorDate: Tue Oct 5 14:24:13 2021 +0200
Set the sidebar at a fixed position.
---
layouts/_default/baseof.html | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html
index 8fb8ef4..8b3aaf0 100644
--- a/layouts/_default/baseof.html
+++ b/layouts/_default/baseof.html
@@ -32,9 +32,8 @@
{{ partial "menu.html" }}
<div class="row flex-nowrap">
- <div class="d-flex flex-column flex-shrink-0 p-3 text-white bg-dark" style="width: 280px;">
- <hr>
- <ul class="nav nav-pills flex-column mb-auto">
+ <div class="d-flex flex-column flex-shrink-0 p-3 text-white bg-dark" style="width: 12rem;">
+ <ul class="nav nav-pills flex-column mb-auto position-fixed">
<li><a class="nav-link {{ if eq .Page.RelPermalink "/" }} active {{ else }} text-white {{ end }}" href="/index.html">Home</a></li>
<li><a class="nav-link text-white" href="http://www.apache.org/licenses/">License</a></li>
<li><a class="nav-link {{ if eq .Page.RelPermalink "/downloads.html" }} active {{ else }} text-white {{ end }}" href="downloads.html">Downloads</a></li>
[sis-site] 02/03: Move DOAP.rdf file and templates as static
resources,
for automatic inclusion in the web site (they were previously copied
manually).
Posted by de...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
desruisseaux pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sis-site.git
commit 7d024e8d0078027c1dc96aa96c5d71866e10dbc8
Author: Martin Desruisseaux <ma...@geomatys.com>
AuthorDate: Tue Oct 5 14:26:29 2021 +0200
Move DOAP.rdf file and templates as static resources, for automatic inclusion in the web site (they were previously copied manually).
---
DOAP.rdf => static/DOAP.rdf | 0
{templates => static/templates}/release-announce.html | 0
{templates => static/templates}/release-discuss.txt | 0
{templates => static/templates}/release-vote.txt | 0
4 files changed, 0 insertions(+), 0 deletions(-)
diff --git a/DOAP.rdf b/static/DOAP.rdf
similarity index 100%
rename from DOAP.rdf
rename to static/DOAP.rdf
diff --git a/templates/release-announce.html b/static/templates/release-announce.html
similarity index 100%
rename from templates/release-announce.html
rename to static/templates/release-announce.html
diff --git a/templates/release-discuss.txt b/static/templates/release-discuss.txt
similarity index 100%
rename from templates/release-discuss.txt
rename to static/templates/release-discuss.txt
diff --git a/templates/release-vote.txt b/static/templates/release-vote.txt
similarity index 100%
rename from templates/release-vote.txt
rename to static/templates/release-vote.txt