fabulator-exhibit

github.com/jgsmith/ruby-fabulator-exhibit

DESCRIPTION:

Fabulator engine extension for creating Exhibit data sources.

Namespace: dh.tamu.edu/ns/fabulator/exhibit/1.0#

See www.simile-widgets.org/exhibit/ for more information on Exhibit

FEATURES/PROBLEMS:

SYNOPSIS:

In Ruby

require 'fabulator/exhibit'

In Fabulator applications

<ex:database ex:database="data">
  <ex:item ex:id="'id'" ex:label="'label'" ex:type="ItemType">
    <ex:value ex:name="key" f:select="'value'" />
  </ex:item>
</ex:database>

REQUIREMENTS:

The uuid gem is required to autogenerate ids.

This Fabulator extension provides to an Exhibit-style database, but does not provide actual storage. The embedding framework will need to define several functions:

Fabulator::Exhibit::Actions::Lib.fetch_database(name)

This function should return the Exhibit database. It needs to look like the following data structure:

{
   :types => { },
   :properties => { },
   :items => { }
}

Fabulator::Exhibit::Actions::Lib.store_database(name, data)

This function should store the data for later retrieval. The data is provided in the same format it is returned by the fetch_database function.

INSTALL:

sudo gem install fabulator-exhibit

LICENSE:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.