Customizing editor

A metadata editor configuration is defined for a specific schema plugin standard (see Implementing schema plugins).

The editor configuration defined the navigation menu (ie. list of views and tabs) for the editor, the list of fields and the type of control to use. Controls could be HTML type (eg. text, date) or more advanced control build using AngularJS directive.

To build such an editor configuration user needs to know the XSD of the standard to properly build views, tabs and fields according to element names (see source file schemas/config-editor.xsd). Create an editor root element and attach:

  • the schema and
  • namespaces for the standards
<editor xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="../../../../../../config-editor.xsd"
  xmlns:gn="http://www.fao.org/geonetwork"
  xmlns:gco="http://www.isotc211.org/2005/gco"
  xmlns:gmd="http://www.isotc211.org/2005/gmd"
  xmlns:gmx="http://www.isotc211.org/2005/gmx"
  xmlns:srv="http://www.isotc211.org/2005/srv"
  xmlns:gml="http://www.opengis.net/gml"
  xmlns:xlink="http://www.w3.org/1999/xlink">

An editor configuration should define first some general element description and then a set of views with at least one.

Child elements:

Defining field type

Define the form fields type configuration. Default is simple text input. This list contains the list of exception which does not use a simple text input. The list of possible values are:

  • all HTML5 input type or
  • an AngularJS directive name.

An element can only have one type defined.

<editor>
 <fields>
   <for name="gmd:abstract" use="textarea"/>
   <for name="gco:Real" use="number"/>
   <for name="gco:Boolean" use="checkbox"/>
   <for name="gco:Date" use="data-gn-date-picker"/>

The other option to define a more advanced field type is to catch the element using and XSL template. This approach is used for keywords in ISO19139 for example (see source file schemas/iso19139/src/main/plugin/iso19139/layout/layout-custom-fields-keywords.xsl).

Grouping element from the standards

List of element to be displayed in a fieldset (ie. boxed element). Those elements usually contain children elements and define major section in the standard. For example, in ISO19139, identification and distribution are major section and should usually be displayed as a group of information.

<editor>
   <fields>...</fields>
   <fieldsWithFieldset>
    <name>gmd:identificationInfo</name>
    <name>gmd:distributionInfo</name>

Defining multilingual fields

Configure here the list of multilingual fields for a standard.

By default, if the standard as multilingual support like ISO19139, all fields will be displayed as multilingual fields. Define in the exclude section the exception (eg. gmd:identifier for example in ISO19139).

Then this section also allows to define how multilingual fields are displayed using the expanded elements. If expanded, then one field per language is displayed with no need to click on the language switcher.

../../_images/multilingual-editing.png
<editor>
   <fields>...</fields>
   <fieldsWithFieldset>...</fieldsWithFieldset>
    <multilingualFields>
      <expanded>
        <name>gmd:title</name>
        <name>gmd:abstract</name>
      </expanded>
      <exclude>
        <name>gmd:identifier</name>
        <name>gmd:metadataStandardName</name>

Configuring views

At least one view MUST be defined but more view modes can be defined depending on the needs.

By default ISO19139 define 3 views (ie. default, advanced, xml) and one disabled (ie. INSPIRE). See source file schemas/iso19139/src/main/plugin/iso19139/layout/config-editor.xml for the configuration.

../../_images/view-mode.png

Another basic example is the Dublin Core view (see source file schemas/dublin-core/src/main/plugin/dublin-core/layout/config-editor.xml).

To create a new view, use the following:

<views>
    <view name="viewNameInLocalizationFile">
      ...
    </view>

Child elements:

Defining a view

A view has a label and define a specific rendering of the metadata records. A view is composed of one or more tabs.

<views>
    <view name="custom-view">
        ....
    </view>

The view could be displayed or not according to the metadata record content or the current user session using the displayIfRecord and displayIfServiceInfo attribute.

Attributes:

  • name (Mandatory)

The key of the view name stored in {schema}/loc/{lang}/strings.xml or the element name with namespace prefix.

<strings>
  <default>Simple</default>
  <inspire>INSPIRE</inspire>
  <custom-view>My view</custom-view>
  • disabled (Optional) Fixed value: true

Hide the view from the menu if the attribute is defined. Allows to easily disable a view.

  • upAndDownControlHidden (Optional) Fixed value: true

Define if up and down control should be displayed in that view. If not defined, controls are displayed. Hide those controls in a view to make it easier with less controls for the end-user.

../../_images/editor-control-updown.png
  • displayIfRecord (Optional)

XPath expression returning boolean value which will be evaluated against the metadata record. if true the view will be displayed. eg. Display custom-view if metadata standard name contains Medsea:

<view name="custom-view"
      displayIfRecord="contains(gmd:MD_Metadata/
                                  gmd:metadataStandardName/gco:CharacterString,
                                'MedSea')"
  • displayIfServiceInfo (Optional)

XPath expression returning boolean value which will be evaluate against the service information tree (Jeeves /root/gui element). if true the view will be displayed.

eg. Display custom view if user is Administrator:

<view name="custom-view"
      displayIfServiceInfo="count(session[profile = 'Administrator']) = 1"

displayIfRecord and displayIfServiceInfo could be combined. An AND operator is used. Both condition MUST returned true for the view to be displayed.

  • hideTimeInCalendar (Optional) Fixed value: true

Define if calendar control should allows users to set date only or datetime. If attribute is not set, then date and time can be set. This is controlled at the view level, switching to another view may allow more control over the dates.

Child elements:

Defining a tab

A view contains at least one tab. In that case it will be the default to display and no top toolbar will be displayed to switch from one tab to another.

../../_images/editor-tab-switcher.png

Add custom view one default tab and a field for the title:

<views>
  <view name="custom-view">
    <tab id="custom-tab" default="true">
      <section>
        <field xpath="/gmd:MD_Metadata/gmd:identificationInfo/*/gmd:citation/*/gmd:title"/>
      </section>
    </tab>
  </view>

Attributes:

  • id (Mandatory)

The tab key used in URL parameter to activate that tab. The key is also use for the tab label as defined in {schema}/loc/{lang}/strings.xml.

  • default (Optional) Fixed value: true

Define if this tab is the default one for the view. Only one tab should be the default in a view.

  • toggle (Optional) Fixed value: true

Define if the tab should be displayed in a drop down menu instead of a tab. This is used for advanced section which is not used often by the end-user. More than one tab could be grouped in that drop down tab menu.

  • mode (Optional) Fixed value: flat

The “flat” mode is an important concept to understand for the editor. It controls the way:

  • complex elements are displayed (ie. elements having children) and
  • non existing elements are displayed (ie. elements in the standard not in the current document).

When a tab is in flat mode, this tab will not display element which are not in the current metadata document and it will display complex element as a group only if defined in the list of element with fieldset (see Grouping element from the standards).

Example for a contact in non “flat” mode:

../../_images/editor-contact-nonflatmode.png

Example for a contact in “flat” mode:

../../_images/editor-contact-flatmode.png

This mode makes the layout simpler but does not provide all controls to remove some of the usually boxed element. End-user can still move to the advanced view mode to access those hidden elements in flat mode.

It’s recommended to preserve at least one view in non “flat” mode for reviewer or administrator in order to be able:

  • to build proper templates based on the standards
  • to fix any types of errors.

Child elements:

Configuring complex element display

Elements to apply “flat” mode exceptions. By default, “flat” mode does not display elements containing only children and no value.

<views>
  <view name="custom-view">
    <tab id="custom-tab" default="true">
      <section>
        <field xpath="/gmd:MD_Metadata/gmd:identificationInfo/*/gmd:citation/*/gmd:title"/>
        <field name="pointOfContact"
               xpath="/gmd:MD_Metadata/gmd:identificationInfo/*/gmd:pointOfContact"
               del="."/>
      </section>
    </tab>
  </view>

eg. To display gmd:descriptiveKeywords element even if does not exist in the metadata record or if the field should be displayed to add new occurences:

  </tab>

  <!-- Elements that should not use the "flat" mode -->
  <flatModeExceptions>
    <for name="gmd:descriptiveKeywords" />
  </flatModeExceptions>
</view>

Customizing thesaurus

To configure the type of transformations or the number of keyword allowed for e thesaurus define a specific configuration:

eg. only 2 INSPIRE themes.

<thesaurusList>
  <thesaurus key="external.theme.inspire-theme"
             maxtags="2"
             transformations=""/>
</thesaurusList>

Adding a section to a tab

A section is a group of fields.

Attributes:

  • name (Optional)

An optional name to override the default one base on field name for the section. The name must be defined in {schema}/loc/{lang}/strings.xml.

  • xpath (Optional)

The xpath of the element to match. If an XPath is set for a section, it should not contains any field.

  • mode (Optional) Fixed value: flat

The “flat” mode is an important concept to understand for the editor. It controls the way:

  • complex elements are displayed (ie. elements having children) and
  • non existing elements are displayed (ie. elements in the standard not in the current document).

When a tab is in flat mode, this tab will not display element which are not in the current metadata document and it will display complex element as a group only if defined in the list of element with fieldset (see Grouping element from the standards).

Example for a contact in non “flat” mode:

../../_images/editor-contact-nonflatmode.png

Example for a contact in “flat” mode:

../../_images/editor-contact-flatmode.png

This mode makes the layout simpler but does not provide all controls to remove some of the usually boxed element. End-user can still move to the advanced view mode to access those hidden elements in flat mode.

It’s recommended to preserve at least one view in non “flat” mode for reviewer or administrator in order to be able:

  • to build proper templates based on the standards
  • to fix any types of errors.
  • or (Optional)

Local name to match if the element does not exist.

  • or (Optional)

The local name of the geonet child (ie. non existing element) to match.

<field xpath="/gmd:MD_Metadata/gmd:language"
       or="language"
       in="/gmd:MD_Metadata"/>
  • in (Optional)

XPath of the geonet:child element with the or name to look for. Usually points to the parent of last element of the XPath attribute.

  • in (Optional)

The element to search in for the geonet child.

Adding a field

To display a simple element use the xpath attribute to point to the element to display:

<field xpath="/gmd:MD_Metadata/gmd:identificationInfo/*/gmd:citation/*/gmd:title"/>

To override a field label use the name attribute and define that new label in {schema}/loc/{lang}/strings.xml:

<field name="myTitle"
       xpath="/gmd:MD_Metadata/gmd:identificationInfo/*/gmd:citation/*/gmd:title"/>

To display a complex element which exist in the metadata document:

<field name="pointOfContact"
       xpath="/gmd:MD_Metadata/gmd:identificationInfo/*/gmd:pointOfContact"/>

In that case all children elements are also displayed.

To display a field if exist in the metadata document or providing a add button in case it does not exist (specify in and or attribute):

<field name="pointOfContact"
       xpath="/gmd:MD_Metadata/gmd:identificationInfo/*/gmd:pointOfContact"
       or="pointOfContact"
       in="/gmd:MD_Metadata/gmd:identificationInfo/*"
       del="."/>

Activate the “flat” mode at the tab level to make the form display only existing elements:

<view name="custom-view">
    <tab id="custom-tab" default="true" mode="flat">
      <section>
        <field
                xpath="/gmd:MD_Metadata/gmd:identificationInfo/*/gmd:citation/*/gmd:title"/>
        <field name="pointOfContact"
               xpath="/gmd:MD_Metadata/gmd:identificationInfo/*/gmd:pointOfContact"
               or="pointOfContact"
               in="/gmd:MD_Metadata/gmd:identificationInfo/*"
               del="."/>
      </section>
    </tab>
  </view>

Attributes:

  • xpath (Mandatory)

The xpath of the element to match.

  • if (Optional)

An optional xpath expression to evaluate to define if the element should be displayed only in some situation (eg. only for service metadata records). eg.

<field
  xpath="/gmd:MD_Metadata/gmd:identificationInfo/srv:SV_ServiceIdentification/
  gmd:resourceConstraints/gmd:MD_LegalConstraints/gmd:otherConstraints"
  if="count(gmd:MD_Metadata/gmd:identificationInfo/srv:SV_ServiceIdentification) > 0"/>
  • name (Optional)

A field name to override the default name.

  • isMissingLabel (Optional)

The label to display if the element does not exist in the metadata record. It indicates that the element is missing in the current record. It could be use for a conformity section saying that the element is “not evaluated”. EXPERIMENTAL

  • or (Optional)

The local name of the geonet child (ie. non existing element) to match.

<field xpath="/gmd:MD_Metadata/gmd:language"
       or="language"
       in="/gmd:MD_Metadata"/>
  • in (Optional)

The element to search in for the geonet child.

  • del (Optional)

Relative XPath of the element to remove when the remove button is clicked.

eg. If a template field match linkage and allows editing of field URL, the remove control should remove the parent element gmd:onLine.

<field name="url"
  xpath="/gmd:MD_Metadata/gmd:distributionInfo/gmd:MD_Distribution/gmd:transferOptions
            /gmd:MD_DigitalTransferOptions/gmd:onLine/gmd:CI_OnlineResource/gmd:linkage"
  del="../..">
  <template>
  • templateModeOnly (Optional) Fixed value: true

Define if the template mode should be the only mode used. In that case, the field is always displayed based on the XML template snippet field configuration. Default is false.

  • notDisplayedIfMissing (Optional) Fixed value: true

If the field is found and a geonet child also, the geonet child to add a new one is not displayed.

Child elements:

Adding a template based field

A templace configuration for an XML snippet to edit.

A template field is compose of an XML snippet corresponding to the element to edit where values to be edited are identified using {{fields}} notation. Each fields needs to be defined as values from which one input field will be created.

This mode is used to hide the complexity of the XML element to edit. eg.

<field name="url"
       templateModeOnly="true"
       xpath="/gmd:MD_Metadata/gmd:distributionInfo/g.../gmd:linkage">
   <template>
     <values>
       <key label="url"
            xpath="gmd:URL"
            tooltip="gmd:linkage"/>
     </values>
     <snippet>t
       <gmd:linkage>
         <gmd:URL>{{url}}</gmd:URL>
       </gmd:linkage>
     </snippet>
   </template>

The template field mode will only provide editing of part of the snippet element. In some case the snippet may contains more elements than the one edited. In such case, the snippet MUST identified the list of potential elements in order to not to loose information when using this mode. Use the gn:copy element to properly combined the template with the current document.

eg. The gmd:MD_Identifier may contain a gmd:authority node which needs to be preserved.

<snippet>
  <gmd:identifier>
    <gmd:MD_Identifier>
      <gn:copy select="gmd:authority"/>
      <gmd:code>
        <gco:CharacterString>{{code}}</gco:CharacterString>
      </gmd:code>
    </gmd:MD_Identifier>
  </gmd:identifier>
</snippet>

Adding documentation or help

Insert an HTML fragment in the editor.

<field name="edmerpName"
       xpath="/gmd:MD_Metadata/gmd:identificationInfo/*/
                gmd:pointOfContact[*/gmd:role/*/@codeListValue='edmerp']"
       del=".">

<text ref="edmerp-help"/>

The fragment is defined in localization file strings.xml:

<edmerp-help>
  <div class="row">
    <div class="col-xs-offset-2 col-xs-8">
      <p class="help-block">The European Directory for Marine Environment
          Research Project (EDMERP) contains descriptions of many projects.
          This catalogue is maintained ...</p>
      </div>
  </div>
</edmerp-help>

Attributes:

  • ref (Mandatory)

The tag name of the element to insert in the localization file.

Adding a button

A button which trigger an action (usually a process or a add button).

Example of a button adding an extent:

<action type="add"
        name="extent"
        or="extent"
        in="/gmd:MD_Metadata/gmd:identificationInfo/gmd:MD_DataIdentification">
    <template>
      <snippet>
        <gmd:extent>
          <gmd:EX_Extent>
            <gmd:geographicElement>
              <gmd:EX_GeographicBoundingBox>
                <gmd:westBoundLongitude>
                  <gco:Decimal/>
                </gmd:westBoundLongitude>
                <gmd:eastBoundLongitude>
                  <gco:Decimal/>
                </gmd:eastBoundLongitude>
                <gmd:southBoundLatitude>
                  <gco:Decimal/>
                </gmd:southBoundLatitude>
                <gmd:northBoundLatitude>
                  <gco:Decimal/>
                </gmd:northBoundLatitude>
              </gmd:EX_GeographicBoundingBox>
            </gmd:geographicElement>
          </gmd:EX_Extent>
        </gmd:extent>
      </snippet>
    </template>
  </action>

Example of a button displayed only if there is no resource identifier ending with the metadata record identifier (ie. if attribute) and running the process with add-resource-id identifier:

<action type="batch"
        process="add-resource-id"
        if="count(gmd:MD_Metadata/gmd:identificationInfo/*/
                      gmd:citation/*/gmd:identifier[
                        ends-with(gmd:MD_Identifier/gmd:code/gco:CharacterString,
                                  //gmd:MD_Metadata/gmd:fileIdentifier/gco:CharacterString)]) = 0"/>

Attributes:

  • name (Optional)

TODO

  • type (Optional)

The type of control

  • process (Optional)

The process identifier (eg. add-resource-id).

  • forceLabel (Optional)

Force the label to be displayed for this action even if the action is not the first element of its kind. Label with always be displayed.

  • if (Optional)

An XPath expression to evaluate. If true, the control is displayed. eg.

count(gmd:MD_Metadata/gmd:identificationInfo/*/gmd:citation/gmd:CI_Citation/
gmd:identifier[ends-with(gmd:MD_Identifier/gmd:code/gco:CharacterString,
//gmd:MD_Metadata/gmd:fileIdentifier/gco:CharacterString)]) = 0

will only displayed the action control if the resource identifier does not end with the metadata identifier.

  • or (Optional)

Local name to match if the element does not exist.

  • or (Optional)

The local name of the geonet child (ie. non existing element) to match.

<field xpath="/gmd:MD_Metadata/gmd:language"
       or="language"
       in="/gmd:MD_Metadata"/>
  • in (Optional)

XPath of the geonet:child element with the or name to look for. Usually points to the parent of last element of the XPath attribute.

  • in (Optional)

The element to search in for the geonet child.

  • addDirective (Optional)

The directive to use for the add control for this field.

Child elements: