Editor / Add configuration for field to use a thesaurus.

[fxprunayre]

Due to the increase of usage of registries (#2741) for managing list of values, catalogue administrators need to be able to configure which thesaurus to use to populate a field in the editor form.

When configured, then an autocomplete list is available in the editor:

Example of usage for use limitation which propose a list of values based on INSPIRE recommendation and Creative commons licenses https://www.youtube.com/watch?v=k5lONHoz-rU&feature=youtu.be

Editor can still enter an alternative text and not pick a value from the list.

Work description

• Add editor configuration / Configuration for field in any views

Sample configurations:

Use LimitationsOnPublicAccess INSPIRE codelist to populate gmd:useLimitation. This is the easiest configuration where you use the data-gn-keyword-picker directive pointing to the thesaurus identified by the data-thesaurus-key. The thesaurus key is available in the admin console > thesaurus panel.

<for name="gmd:useLimitation"
         use="data-gn-keyword-picker">
  <directiveAttributes data-thesaurus-key="external.theme.httpinspireeceuropaeumetadatacodelistLimitationsOnPublicAccess-LimitationsOnPublicAccess"/>
</for>

Additional attributes are available to customize the suggestion:

• data-number-of-suggestions define the number of suggestions to list
• data-display-definition allows to display the definition

<for name="gmd:otherConstraints"
         use="data-gn-keyword-picker">
      <directiveAttributes 
              data-thesaurus-key="external.theme.httpinspireeceuropaeumetadatacodelistOnLineDescriptionCode-OnLineDescriptionCode"
              data-display-definition="true"/>
</for>

• Add editor configuration / Configuration for field in a specific view. Use and directive attributes can be used in a field defined in a view:

   <tab id="default" default="true" mode="flat">
        <section>
          <field xpath="/gmd:MD_Metadata/gmd:identificationInfo/*/gmd:language"
                 use="data-gn-keyword-picker">
            <directiveAttributes
              data-thesaurus-key="external.theme.httpinspireeceuropaeumetadatacodelistOnLineDescriptionCode-OnLineDescriptionCode"
              data-display-definition="true"
              data-thesaurus-concept-id-attribute="xlinkCOLONhref"/>
          </field>
        </section>

• Add multilingual support. Populate all translations based on the record languages and the languages available in the thesaurus.

• Add Anchor encoding / Use keyword id when using autocomplete list (Editor config / Define which fields can be populated from thesaurus and choose encoding mode eg. gmx:anchor #3044)
• Add Anchor encoding / Use URL (Option to switch between characterString and Anchor #2867)
• Add Anchor with multilingual encoding / Keep Anchor instead of CharacterString (See https://github.com/geonetwork/core-geonetwork/blob/master/schemas/iso19139/src/main/plugin/iso19139/update-fixed-info.xsl#L297-L309)

<gmx:Anchor xlink:href="http://example.com/fr">francais</gmx:Anchor>
<gmd:PT_FreeText>
   <gmd:textGroup>
      <gco:localisedCharacterString locale="#EN">english</gco:localisedCharacterString>
   </gmd:textGroup>
</gmd:PT_FreeText>

• Add any attribute encoding based on concept id. Example for a LocalName element:

<gmd:featureTypes>
  <gco:LocalName codeSpace="http://purl.org/myocean/ontology/vocabulary/feature-type#Grid">Grid</gco:LocalName>
</gmd:featureTypes>

... the configuration would be:

          <field xpath="/gmd:MD_Metadata/gmd:contentInfo/*/gmd:featureTypes"
                   use="data-gn-keyword-picker">
              <directiveAttributes data-thesaurus-key="local.feature-type.myocean.feature-type"
                                              data-thesaurus-concept-id-attribute="codeSpace"/>
          </field>

This mode is recommended to be used instead of using helper which may trigger issues in multilingual context (#3076)

Schema plugin changes for ISO19139 extension:

• add the following to config-editor.xml

    <for name="gts:TM_PeriodDuration" use="data-gn-field-duration-div"/>
    <for name="gml:duration" use="data-gn-field-duration-div"/>

• Update type mapping for attribute (to avoid to use a field directive on an attribute)

    <for name="src" use="data-gn-logo-selector"/>

by

    <for name="gmx:FileName/@src" use="data-gn-logo-selector"/>

• replace for topic category (if using it)

      <xsl:with-param name="directive" select="'gn-topiccategory-selector'"/>

by

      <xsl:with-param name="type" select="'data-gn-topiccategory-selector-div'"/>

• Add field configuration per view in dispatcher template

--- a/schemas/iso19139/src/main/plugin/iso19139/layout/dispatcher.xsl
+++ b/schemas/iso19139/src/main/plugin/iso19139/layout/dispatcher.xsl
@@ -50,9 +50,11 @@
     <xsl:param name="base" as="node()"/>
     <xsl:param name="overrideLabel" as="xs:string" required="no" select="''"/>
     <xsl:param name="refToDelete" as="node()?" required="no"/>
+    <xsl:param name="config" as="node()?" required="no"/>
     <xsl:apply-templates mode="mode-iso19139" select="$base">
       <xsl:with-param name="overrideLabel" select="$overrideLabel"/>
       <xsl:with-param name="refToDelete" select="$refToDelete"/>
+      <xsl:with-param name="config" select="$config"/>
     </xsl:apply-templates>
   </xsl:template>

Future work to plan

• Indexing / Check indexing of Anchors and render them properly
• UI / Make link field layout more consistent (in attribute div or in the form or with "add/update link" button)
• UI / Display links when set (once indexed for the Angular view, add support for multilingual Anchor in XSL formatter)
• UI / Display images when link point to an image (related to XSL Formatter / handle logos in contact info #3149)

[pvgenuchten]

Does this approach also allow users to not use the pull-down value and enter an alternative text (which is then stored as characterstring in stead of anchor?

as described here #2867

[fxprunayre]

Does this approach also allow users to not use the pull-down value and enter an alternative text (which is then stored as characterstring in stead of anchor?

Yes the pull down is only suggestions from the thesaurus. Free text is still allowed.

[pvgenuchten]

How does this work on xml for multilingual, like this?

<gmx:Anchor xlink:href="http://example.com/fr">francais</gmx:Anchor>
<gmd:PT_FreeText>
   <gmd:textGroup>
      <gmx:Anchor xlink:href="http://example.com/en">english</gmx:Anchor>
   </gmd:textGroup>
</gmd:PT_FreeText>

but then is missing the locale

or alternatively:

<gmx:Anchor xlink:href="http://example.com/fr">francais</gmx:Anchor>
<gmd:PT_FreeText>
   <gmd:textGroup>
      <gco:localisedCharacterString locale="#EN">english</gco:localisedCharacterString>
   </gmd:textGroup>
</gmd:PT_FreeText>

[fxprunayre]

How does this work on xml for multilingual, like this?

Testing with Oxygen, the schema validation works when you only substitute the CharacterString with the Anchor. The multilingual part is the same.

[pvgenuchten]

Seems 6 modes of configuration are relevant for any text element

	text	anchor
free	text	text
optional codelist	text+suggest	-
required codelist	keyword directive (no xlinkCOLONhref)	keyword directive (xlinkCOLONhref)

The one missing in the current approach seems anchor+optional codelist, in which a user could select a value from a codelist or enter a value+link manually

And missing is a way to switch between anchor and string for no-codelist fields as described in #2867

[fxprunayre]

Seems 6 modes of configuration are relevant for any text element

@pvgenuchten, what do you mean by suggest ? helpers set in labels.xml ?

I don't think we should bother editor with a choice between CharacterString or Anchor choice. The rule could be simple : if a link is defined, encode with an Anchor, if not, use a CharacterString. This is handled by https://github.com/geonetwork/core-geonetwork/pull/3078/files#diff-d7aa3900840fb8648241a671c2b92be1R414. This is working now in this branch for keyword picker based field. So we should add this to standard field and apply the rule when a link is set. Then maybe the layout of this link field should be improved.

We should avoid usage of helpers (and maybe drop support for it at some point) and prefer use of thesaurus codelist.

[pvgenuchten]

I like the idea of not bothering the user with anchor/string choice.
I'm also in favour to remove the helper option in labels.xml

Some use cases around anchor/string/codelist, derived from dutch profile.

Text field that either or not has an anchor-link defined
This applies for example for the organisationName field. The specification suggests to insert the organisationName with an Anchor linking to an URI defining the organisation. Another example is the gmd:identifier field

<gmd:identifier>
<gmd:MD_Identifier>
<gmd:code>
<Anchor
  xlink:href="http://domein/id/record/ee543323-0fe4-4353">
  ee543323-0fe4-4353-9161-eda61ff26c07</Anchor>
</gmd:code>
</gmd:MD_Identifier>
</gmd:identifier>

Text field that could use a value from a codelist
Some options here:

• field does not use an xlink (should be encoded as characterString)
• field does have an xlink but not one from the suggested codelist
• field uses a value from the suggested codelist

An example here is gmd:protocol in onlineresource

<gmd:protocol>
      <gmx:Anchor
        xlink:href="https://www.iana.org/assignments/media-types/application/json">
        json</gmx:Anchor>
</gmd:protocol>

Dropdown field that must use a value from a codelist

• legal-constraints
• conformsto-specification-title

<gmd:report>
<gmd:title>
<gmx:Anchor
 xlink:href="http://inspire.ec.europa.eu/id/document/tg/au">
   Data specificatie administratieve eenheden
</gmx:Anchor>
</gmd:title>
</gmd:report>

challenge here is that individual quality reports or restriction elements may require values from multiple codelists. What could be an option here is to create a field entry in config.xml for each thesaurus to be used

[fxprunayre]

A review/merge of this one would be good to not to have to solve conflict for weeks. It has been tested by Ifremer and is used for custom editor views using both ISO19139 and ISO19115-3 (changes ready camptocamp/iso19115-3@d81d758 to be integrated in metadata101).

[josegar74]

I have tested (no multilingual) using Text and Anchors for Use limitations and looks working fine.

[pvgenuchten]

i know this is merged, but would like to add this listing of various potential modes of visualisation for the various modes this directive can be used in

[pvgenuchten]

the widget does not have a help-icon/tooltip yet

[cmangeat]

@fxprunayre , why not
el.setAttribute("href", attributeValue, XLINK);

[fxprunayre]

Maybe because the attribute value is assigned after in https://github.com/geonetwork/core-geonetwork/blob/master/services/src/main/java/org/fao/geonet/api/records/editing/AjaxEditUtils.java#L236 ? Not 100% sure.