berkeleybop/golr-conf

Name: golr-conf

Owner: Berkeley BOP

Description: GOlr configuration file handling and API.

Created: 2015-11-16 23:15:52.0

Updated: 2016-10-21 05:15:48.0

Pushed: 2016-10-21 21:42:22.0

Homepage: null

Size: 12

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

golr-conf

Overview

GOlr configuration handling and API.

Grossly put, the set of YAML files that define the possible search interfaces for GOlr are turned into JSON and fed as instantiating data into this API.

Currently, this is only really useful in the context of configuring a bbop-manager-golr instance, or driving related GOlr widgetry.

This package contains three sub-packages:

• conf: the top-level configuration, it is a set of conf_classes (including some meta-information; roughly the set of all YAML files
• conf_class: a set of conf_fields, including extra meta-information for displays and search boosts; roughly equivalent to a single YAML file or a “personality”
• conf_field: a single entry, including information such as type, label, and tooltip text; roughly equivalent to an entry in a YAML file

The main current example of the conversion of the YAML source files to the JSON used for class instantiation is the blob used by the standard AmiGO GOlr configuration load. It easy to seen the similarities between the AmiGO 2 instance configuration YAML files and the JSON output used to drive the JavaScript interface.

(The YAML to JSON conversion has traditionally been done ad-hoc or with an old perl script, but we're currently looking at a direct YAML to JSON conversion for instantiation–feel free to drop us a line.)

For more detailed information, please see the unit tests.

Availability

GitHub

NPM

API

index