iso19139.ca.HNAP 4.2.6 Release
ISO Harmonized North American Profile (HNAP) plugin for GeoNetwork
The Canadian GeoNetwork community is pleased share the ISO Harmonized North American Profile (HNAP) schema plugin. This is a bilingual extension of the North American Profile of ISO 19115:2003 - Geographic information - Metadata used nationally.
For details on this release see 4.2.6 Milestone release notes for details.
User Manual
User Manual (HNAP) is provided for end-users. The user manual explores catalog use using HNAP examples. This is an end-user supliment to the far more technical GeoNetwork User and Developer Manuals.
This user manual is available for local installation.
Communication
The project issue tracker is used for communication, with ongoing topics tagged discussion.
Installation
GeoNetwork version to use with this plugin
Use GeoNetwork 4.2.x
, not tested with prior versions!
The schema plugin editor makes use of a number of controls for editing structured text fields requiring newer releases of core-geonetwork.
Deploy the profile in an existing installation
The plugin can be deployed manually in an existing GeoNetwork installation:
-
Download from releases page.
Each release includes a
jar
,zip
, anddoc
download. -
Extract contents of the
schema-iso19139.ca.HNAP
zip download intoWEB-INF/data/config/schema_plugins/iso19139.ca.HNAP
. -
Copy the
schema-iso19139.ca.HNAP
jar to geonetworkWEB-INF/lib
-
Copy the
schema-iso19139.ca.HNAP
doc to geonetworkdoc
-
Restart geonetwork
There is some custom initialization code run when GeoNetwork starts up:
-
The plugin includes will check the GeoNetwork Data Directory
ThesauriDir
to see if the HNAP Thesauruses are already installed. -
If they are not (i.e. this is the very first run of GeoNetwork with the HNAP Schema), the required thesaurus files are are copied from the
jar
into to the correct location in the Data Directory.
See SchemaInitializer.java
for details.
Building
Adding the plugin to the source code
The best approach is to add the plugin as a submodule:
-
Use add-schema.sh for automatic deployment:
./add-schema.sh iso19139.ca.HNAP https://github.com/metadata101/iso19139.ca.HNAP 4.2.x
-
Build the application:
mvn clean install -Penv-prod -DskipTests
-
Once the application is built, the war file contains the schema plugin:
cd web mvn jetty:run -Penv-dev
Deploy locally built profile into existing installation
-
Copy the
iso19139.ca.HNAP
folder fromschemas/iso19139.ca.HNAP/src/main/plugin
into geonetworkWEB-INF/data/config/schema_plugins/
. -
Copy
schema-iso19139.ca.HNAP
jar fromtarget
into geonetworkWEB-INF/lib
. -
Restart geonetwork
Documentation
Documentation is sphinx-build with sphinx-rtd-theme. GeoCat has provided a writing guide on the use of rst
directives and formatting.
Generated docs:
mvn clean compile -Pdocs
Docs generated into target/html/index.html
:
open target/html/index.html
Package docs into zip
:
mvn package -Pdocs
sphinx-build environment
windows:
pip install -U sphinx
pip install hieroglyph recommonmark sphinx-copybutton
macOS:
brew install python
brew install sphinx-doc
pip install hieroglyph recommonmark sphinx-copybutton
jenkins:
Project Procedures
Publish User Guide Process
update github pages
mvn clean install -Pdocs
git add docs
git commit -m "update docs"
git push
User Guide Internationalization
Before you start:
pip install sphinx-intl
Translation workflow:
-
Generate
pot
files, and generate messages for translation:mvn compile -Ptranslate
This performs:
sphinx-build -b gettext src/sphinx target/gettext sphinx-intl -c src/sphinx/conf.py update -p target/gettext -l fr
-
Each
rst
file has a matching messagespo
file insrc/local/fr/LC_MESSAGES
.Message files follow the
gettext
portable objectpo
format:#: ../../src/sphinx/index.rst:3 338fd9f388f64839963b54e20898e403 msgid "User Manual" msgstr "Manuel d'Utilisateur"
Messages are described using:
#
a comment documenting the line number, and a uuid used to help as content is updated over timemsgid
origionalmsgstr
translation, please take care not to break sphinx directives
Plenty of tools are available to work with ``po` files.
-
Optional: translates images, figures and screen snaps:
img/sample.png
origional, `img/sample_fr.png`` translation.figure/example.svg
origional,figure/example_fr.svg
translation.
-
For more information:
Release Process
-
Update the
pom.xml
version information for release:find . -name 'pom.xml' -exec sed -i '' 's/3.12-SNAPSHOT/3.12.7/g' {} \;
-
Update the src/main/plugin/iso19139.ca.HNAP/schema-ident.xm
appMinorVersionSupported
:sed -i '' 's/3.12-SNAPSHOT/3.12.7/g' src/main/plugin/iso19139.ca.HNAP/schema-ident.xml
-
Build everything, including docs, deploying to osgeo repository:
mvn clean install deploy -Pdocs
-
Commit and tag
git add . git commit -am "Version 3.12.7" git tag -a 3.12.7 -m "Release 3.12.7" git push origin 3.12.7
-
Navigate to release page: https://github.com/metadata101/iso19139.ca.HNAP/releases
Click
Edit tag
button:-
Title:
iso19139.ca.HNAP 3.12.7 Release
-
Content: Copy from README.md
-
Upload artifacts from
target
to the new github page.
-
-
Restore the
pom.xml
andschema-ident.xml
version information.find . -name 'pom.xml' -exec sed -i '' 's/3.12.7-0/3.12-SNAPSHOT/g' {} \; sed -i '' 's/3.12.7-0/3.12-SNAPSHOT/g' src/main/plugin/iso19139.ca.HNAP/schema-ident.xml
-
Create the next milestone: https://github.com/metadata101/iso19139.ca.HNAP/milestones
- Title:
3.12.8
- Date: leave empty
- Content:
Released in conjunction with core-geonetwork 3.12.8.
- Title:
-
Update
README.md
to link to new milestone:For details on this release see [3.12.8 Milestone](https://github.com/metadata101/iso19139.ca.HNAP/milestone/5?closed=1) release notes for details.
-
Commit
git add . git commit -m "Start 3.12.8 development" git push