getdkan / dkan_sci_metadata

DKAN Science Metadata Module

DKAN Science Metadata

This module adds Science Metadata related paragraph bundles to the DKAN dataset content type, and Dkan Sci Search index logic.

More documentation coming soon...

Submodules

DKAN Sci Author (modules/dkan_sci_author)

• Provides a child paragraph bundle for adding authors. Includes Author ID, Author ID Type (ORCID, Google Scholar, ResearcherID, Scopus Author ID, USDA), Author Name, and Is Organization fields. Validates ORCID IDs and retrieve biography information to populate name field. ORCID IDs

DKAN Sci Citation (modules/dkan_sci_citation)

• Support for DOI-based citations. Adds a citation bundle that allows adding via either a free text field or a DOI. If DOI is used, the full citation is retrieved from CrossRef and displayed properly on the dataset page. See module README for details.

License

DKAN and related modules are freely-available under the "GNU General Public License, version 3 or any later version" license.

Acknowledgements

Copyright 2017-2020 CivicActions, Inc.

This module was partially funded by the US Department of Agriculture, as part of the development of the Ag Data Commons.

Any opinions, findings, conclusion, or recommendations expressed in this publication are those of the author(s) and do not necessarily reflect the view of the US. Department of Agriculture.

dkan_sci_metadata's Issues

Turn off sticky tables on paragraphs.

We don't need the sticky table behavior on paragraph forms - they should scroll normally like the rest of the page.

Fix citations preview

The citation preview button doesn't do anything currently. Fix.

Investigate other search alter possibilities

Initially we provide a second search index, but perhaps that is not necessary out of the box. The real reason we do this is to support searches of file contents. But we could take an alter appoach, as USDA did. For instance:

/**
 * Implements hook_default_search_api_index_alter().
 */
function nal_author_field_default_search_api_index_alter(&$defaults) {
  if (isset($defaults['datasets'])) {
    $defaults['datasets']->options['fields']['field_nal_author:field_nal_author_name'] = array(
      'type' => 'list<string>',
    );
    $defaults['datasets']->options['fields']['field_nal_author:item_id'] = array(
      'type' => 'list<integer>',
    );
  }
}

function nal_author_field_enable_facets() {
  $searchers = array('search_api@datasets');
  foreach($searchers as $searcher) {
    $realm = "block";
    $facets_to_enable = array('field_nal_author:field_nal_author_name','field_nal_author:item_id');

    $adapter = facetapi_adapter_load($searcher);
    $facet_info = facetapi_get_facet_info($searcher);

    foreach (array_keys($facet_info) as $item) {
      $facet = facetapi_facet_load($item, $searcher);
      if (in_array($item,$facets_to_enable)) {
        $facet_settings = $adapter->getFacet($facet)->getSettings($realm);
        $facet_settings->enabled = 1;
        ctools_export_crud_save('facetapi', $facet_settings);
      }
    }
  }
}

Implement metadata table for science

Metadata table theming for science fields was not added to the module. These fields should show in a table.

Control paragraph form width

The science metadata paragraph extends across the page, which is awkward. Use CSS to control the width.

Citations preview should be accessible

Check the citations preview modal for accessibility. Here's some reference:

https://bitsofco.de/accessible-modal-dialog/