Documentation / Generate schema documentation and embed doc in webapp.

[fxprunayre]

Proposal

This PR adds the following:

• Angular apps can point to geonetwork-opensource.org doc or the webapp doc (see globalSettings)
• Angular apps provide more links to the doc (eg. harvesting, standards, classification, ...)
• A new maven module generate schema documentation based on config-editor.xml

The main goals are to:

• give more visibility to the documentation and the work made on standards documentation
• create documentation which match editor encoding rules

This may encourage people to help improving the content and configuration of the standards (instead of creating dedicated encoding guidelines/wiki/...).

CFV 31 March 2016

• +1 Patrizia, Florent, Francois

Link to the doc

Simply use the gn-need-help directive and point to the doc page:

<div data-gn-need-help="user-guide/quick-start/index.html"></div>

Also add link to quick start when catalog is empty

Schema documentation

Schema documentation creation is driven by config-editor.xml. The documentation
describes:

• Schema introduction (related to Schema documentation #1478)
• Editor views, tabs complete description
• Encoding in XML could be added using an XML template
• Glossary of all standard elements
• Glossary for all codelists

The process is based on XSLT which is using:

• config-editor.xml
• loc/eng|fre/labels.xml
• loc/eng|fre/codelist.xml
• (optional) figure can be added to schema folder/doc/en|fr/img and will be embedded automatically to the doc if defined (eg. image for the data quality tab in advanced view)
• (optional) XML snippet inserted if a template is provided is schema folder/doc/tpl.xml

The XSL process generate RST format documentation.

Demo

The standard documentation can be previewed here http://files.titellus.net/tmp/doc/en/standards/iso19139.html

Support

English and french are created.

Dublin-core, ISO19110 and ISO19139 are created. ISO19115-3 is also supported. It was tested on custom editor for Metawal project in ISO19115-3 and Dublin core custom view for GrandLyon.

This work was mainly supported by the Metawal project.

Future improvements

• Include schematron validation tests description
• Add links between codelist and elements
• Add support for advanced config-editor modes (eg. template mode)

[fgravin]

Very good work thanks.

Is it preferrable to link to an embedded doc or to the official one ?

[fxprunayre]

Is it preferrable to link to an embedded doc or to the official one ?

Maybe we should point to the online one by default so general users can get the latest changes from the doc which is updated by Jenkins on the website. And then when building custom version or "offline" version of GeoNetwork, then user can configure the build to use the embedded version.

[fgravin]

Maybe we should point to the online one by default

Yes i think it's better to point on the official online doc.