7743534eac
* Also remove recline.Model.backends registry as can be replaced with this more generic solution. * This refactoring is necessitated by our need to serialize backend info for save/reload of a dataset and explorer state in #88.
335 lines
13 KiB
HTML
335 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<title>Recline Data Explorer and Library</title>
|
|
|
|
<!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
|
|
<!--[if lt IE 9]>
|
|
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
|
|
<link rel="stylesheet" href="vendor/bootstrap/2.0.2/css/bootstrap.css" />
|
|
<link rel="stylesheet" href="http://opendatahandbook.org/en/_static/bootstrap-sphinx.css" />
|
|
<link rel="stylesheet" href="vendor/bootstrap/2.0.2/css/bootstrap-responsive.css" />
|
|
|
|
<style type="text/css">
|
|
html, body {
|
|
background-color: #eee;
|
|
}
|
|
body {
|
|
padding-top: 50px;
|
|
}
|
|
|
|
.content {
|
|
background-color: #fff;
|
|
padding: 20px;
|
|
margin: 0 -20px; /* negative indent the amount of the padding to maintain the grid system */
|
|
-webkit-border-radius: 0 0 6px 6px;
|
|
-moz-border-radius: 0 0 6px 6px;
|
|
border-radius: 0 0 6px 6px;
|
|
-webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15);
|
|
-moz-box-shadow: 0 1px 2px rgba(0,0,0,.15);
|
|
box-shadow: 0 1px 2px rgba(0,0,0,.15);
|
|
}
|
|
|
|
.page-header {
|
|
background-color: #f5f5f5;
|
|
padding: 20px 20px 10px;
|
|
margin: -20px -20px 20px;
|
|
}
|
|
|
|
.page-header h1 {
|
|
font-size: 30px;
|
|
}
|
|
|
|
ul.deps {
|
|
font-size: 85%;
|
|
}
|
|
|
|
.getit-btn {
|
|
margin: 10px 0px;
|
|
}
|
|
|
|
.getit-btn a {
|
|
width: 95%;
|
|
text-align: center;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="navbar-inner">
|
|
<div class="container">
|
|
<a class="brand" href="#">Recline Data Explorer and Library</a>
|
|
<ul class="nav">
|
|
<li><a href="app/">Data Explorer</a></li>
|
|
<li><a href="#docs">Docs</a></li>
|
|
<li><a href="http://github.com/okfn/recline/">Code on GitHub</a></li>
|
|
</ul>
|
|
<a class="nav-logo pull-right" href="http://okfn.org/" title="An Open Knowledge Foundation Project">
|
|
<img src="http://assets.okfn.org/p/okfn/img/logo_28x30.png" alt="Open Knowledge Foundation logo" />
|
|
</a>
|
|
<ul class="nav" style="float: right;">
|
|
<li><a href="http://twitter.com/maxogden">@maxogden</a></li>
|
|
<li><a href="http://twitter.com/rufuspollock">@rufuspollock</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="container">
|
|
<div class="row"><div class="span9"><div class="content">
|
|
|
|
<div class="page-header">
|
|
<h1>
|
|
Recline Data Explorer and Library<br />
|
|
<small>
|
|
A. Powerful data explorer built in pure javascript and html
|
|
<br />
|
|
B. Suite of data components - grid, graphing and data connectors
|
|
<br />
|
|
— All built with <a href="http://backbonejs.org/">Backbone</a></small>
|
|
</h1>
|
|
</div>
|
|
|
|
<p>Recline is two things:</p>
|
|
|
|
<ul>
|
|
<li>A Data Explorer combining a data grid, Google Refine-style data
|
|
transforms and visualizations all in lightweight javascript and html.</li>
|
|
<li>A simple but powerful library of extensible of data components - data
|
|
grid, graphing, and data connectors - which you can selectively use and build
|
|
on.</li>
|
|
</ul>
|
|
|
|
<p>The Explorer can be used standalone (just download and use) or can be
|
|
embedded into your own site. Recline builds on the powerful but lightweight
|
|
Backbone framework making it extremely easy to extend and adapt. The library's
|
|
modular design mean means you only have to take what you need.</p>
|
|
|
|
<h2 id="features">Main Features</h2>
|
|
<ul>
|
|
<li>View and edit your data in a clean grid / table interface</li>
|
|
<li>Bulk update/clean your data using an easy scripting UI</li>
|
|
<li>Easily extensible with new Backends so you can connect to your
|
|
database or storage layer</li>
|
|
<li>Visualize data</li>
|
|
<li>Open-source, pure javascript and designed for integration -- so it is
|
|
easy to embed in other sites and applications</li>
|
|
<li>Built on the simple but powerful <a
|
|
href="http://documentcloud.github.com/backbone/">Backbone</a> giving a
|
|
clean and robust design which is easy to extend</li>
|
|
<li>Properly designed model with clean separation of data and presentation</li>
|
|
<li>Componentized design means you use only what you need</li>
|
|
</ul>
|
|
|
|
<h2>Screenshots</h2>
|
|
<p><a href="app/"><img src="http://farm8.staticflickr.com/7020/6847468031_0f474de5f7_b.jpg" alt="Recline Data Explorer Screenshot" style="width: 700px; display: block; margin-bottom: 30px;" /></a></p>
|
|
|
|
<h2 id="demo">Demo</h2>
|
|
<p><a href="app/index.html" class="btn">For demo see the Data Explorer »</a></p>
|
|
|
|
<h2 id="docs">Data Explorer Documentation</h2>
|
|
|
|
<p>Usage instructions are built into the <a href="app/">Data Explorer</a>
|
|
itself so no specific additional documentation is provided on usage.</p>
|
|
|
|
<p>To embed the data explorer in another site you can use a simple iframe in
|
|
your web page:</p>
|
|
|
|
<textarea class="span6"><iframe src="http://okfnlabs.org/recline/app/" width="100%"></iframe></textarea>
|
|
|
|
<p>Alternatively, you can initialize the explorer yourself from javascript. To
|
|
see how to do this just take at look at the Explorer's initialization
|
|
javascript in: <a href="app/js/app.js">app.js</a>.</p>
|
|
|
|
|
|
<h2 id="docs">Library Documentation</h2>
|
|
|
|
<h3 id="docs-using">Examples</h3>
|
|
|
|
<p><strong>Note:</strong> A quick read through of the Concepts section will
|
|
likely be useful in understanding the details of the examples.</p>
|
|
|
|
<p><strong>Note</strong>: for all the following examples you should have
|
|
included relevant Recline dependencies.</p>
|
|
|
|
<h4>Simple in-memory dataset.</h4>
|
|
<pre>
|
|
// Some data you have
|
|
// Your data must be in the form of list of documents / rows
|
|
// Each document/row is an Object with keys and values
|
|
var data = [
|
|
{id: 0, x: 1, y: 2, z: 3, country: 'UK', label: 'first'}
|
|
, {id: 1, x: 2, y: 4, z: 6, country: 'UK', label: 'second'}
|
|
, {id: 2, x: 3, y: 6, z: 9, country: 'US', label: 'third'}
|
|
];
|
|
|
|
// Create a Dataset object from local in-memory data
|
|
// Dataset object is a Backbone model - more info on attributes in model docs below
|
|
var dataset = recline.Backend.createDataset(data);
|
|
|
|
// Now create the main explorer view (it will create other views as needed)
|
|
// DataExplorer is a Backbone View
|
|
var explorer = recline.View.DataExplorer({
|
|
model: dataset,
|
|
// you can specify any element to bind to in the dom
|
|
el: $('.data-explorer-here')
|
|
});
|
|
// Start Backbone routing (if you want routing support)
|
|
Backbone.history.start();
|
|
</pre>
|
|
|
|
<h4>Creating a Dataset Explicitly with a Backend</h4>
|
|
<pre>
|
|
// Connect to ElasticSearch index/type as our data source
|
|
// There are many other backends you can use (and you can write your own)
|
|
var backend = new recline.Backend.ElasticSearch();
|
|
|
|
// Dataset is a Backbone model so the first hash become model attributes
|
|
var dataset = recline.Model.Dataset({
|
|
id: 'my-id',
|
|
// url for source of this dataset - will be used by backend
|
|
url: 'http://localhost:9200/my-index/my-type',
|
|
// any other metadata e.g.
|
|
title: 'My Dataset Title'
|
|
},
|
|
backend
|
|
);
|
|
</pre>
|
|
|
|
<h3 id="docs-concepts">Concepts and Structure</h3>
|
|
|
|
<p>Recline has a simple structure layered on top of the basic Model/View
|
|
distinction inherent in Backbone.</p>
|
|
|
|
<h4>Models</h4>
|
|
<p>There are two main model objects:</p>
|
|
<ul>
|
|
<li><a href="docs/model.html#dataset">Dataset</a>: represents the dataset.
|
|
Holds dataset info and a pointer to list of data items (Documents in our
|
|
terminology) which it can load from the relevant Backend.</li>
|
|
<li><a href="docs/model.html#document">Document</a>: an individual data item
|
|
(e.g. a row from a relational database or a spreadsheet, a document from from
|
|
a document DB like CouchDB or MongoDB).</li>
|
|
</ul>
|
|
|
|
<p>Additional, related models:</p>
|
|
<ul>
|
|
<li><a href="docs/model.html#field">Field</a>: a field/column on a
|
|
dataset.</li>
|
|
<li><a href="docs/model.html#query">Query</a>: an object to encapsulate a
|
|
query to the backend (useful both for creating queries and for storing and
|
|
manipulating query state - e.g. from a query editor).</li>
|
|
<li><a href="docs/model.html#facte">Facet</a>: Object to store Facet
|
|
information, that is summary information (e.g. values and counts) about a
|
|
field obtained by some faceting method on the backend.</li>
|
|
</ul>
|
|
|
|
<p>More detail of how these work can be found in the <a
|
|
href="docs/model.html">Model source docs</a>.</p>
|
|
|
|
<h4>Backends</h4>
|
|
<p>Backends connect Dataset and Documents to data from a
|
|
specific 'Backend' data source. They provide methods for loading and saving
|
|
Datasets and individuals Documents as well as for bulk loading via a query API
|
|
and doing bulk transforms on the backend.</p>
|
|
|
|
<p>A template Base class can be found <a href="docs/backend/base.html">in the
|
|
Backend base module of the source docs</a>. It documents both the relevant
|
|
methods a Backend must have and (optionally) provides a base 'class' for
|
|
inheritance. You can also find detailed examples of backend implementations in
|
|
the source documentation below.</p>
|
|
|
|
<h4>Views</h4>
|
|
<p>Complementing the model are various Views (you can
|
|
also easily write your own). Each view holds a pointer to a Dataset:</p>
|
|
<ul>
|
|
<li>DataExplorer: the parent view which manages the overall app and sets up
|
|
sub views.</li>
|
|
<li>Grid: the data grid view.</li>
|
|
<li>Graph: a simple graphing view using <a
|
|
href="http://code.google.com/p/flot/">Flot</a>.</li>
|
|
<li>Map: a map view using <a href="http://leaflet.cloudmade.com/">Leaflet</a>.</li>
|
|
</ul>
|
|
|
|
<p>There are additional views which do not display a whole dataset but which
|
|
are useful:</p>
|
|
<ul>
|
|
<li>QueryEditor: a query editor view</li>
|
|
<li>FacetViewer: display facets</li>
|
|
</ul>
|
|
|
|
|
|
<h3 id="docs-source">Source Docs (via Docco)</h3>
|
|
<h4>Models and Views (Widgets)</h4>
|
|
<ul>
|
|
<li><a href="docs/model.html">Models</a></li>
|
|
<li><a href="docs/view.html">DataExplorer View (plus common view code)</a></li>
|
|
<li><a href="docs/view-grid.html">(Data) Grid View</a></li>
|
|
<li><a href="docs/view-graph.html">Graph View (based on Flot)</a></li>
|
|
<li><a href="docs/view-map.html">Map View (based on Leaflet)</a></li>
|
|
</ul>
|
|
|
|
<h4>Backends</h4>
|
|
<ul>
|
|
<li><a href="docs/backend/base.html">Backend: Base (base class providing a template for backends)</a></li>
|
|
<li><a href="docs/backend/memory.html">Backend: Memory (local data)</a></li>
|
|
<li><a href="docs/backend/elasticsearch.html">Backend: ElasticSearch</a></li>
|
|
<li><a href="docs/backend/dataproxy.html">Backend: DataProxy (CSV and XLS on the Web)</a></li>
|
|
<li><a href="docs/backend/gdocs.html">Backend: Google Docs (Spreadsheet)</a></li>
|
|
<li><a href="docs/backend/localcsv.html">Backend: Local CSV file</a></li>
|
|
</ul>
|
|
|
|
<h2 id="tests">Tests</h2>
|
|
<p><a href="test/index.html">Run the tests online</a>.</p>
|
|
|
|
<h2 id="history">History</h2>
|
|
<p>Max Ogden was developing Recline as the frontend data browser and editor for
|
|
his <a href="http://datacouch.com/">http://datacouch.com/</a> project.
|
|
Meanwhile, Rufus Pollock and the <a href="http://ckan.org/">CKAN team</a> at
|
|
the <a href="http://okfn.org/">Open Knowledge Foundation</a> had been working
|
|
on a <a href="http://github.com/okfn/dataexplorer">Data Explorer</a> for use in
|
|
<a href="http://thedatahub.org">the DataHub</a> and <a
|
|
href="http://ckan.org/">CKAN software</a>.</p>
|
|
|
|
<p>When they met up, they realized that they were pretty much working on the
|
|
same thing and so decided to join forces to produce the new Recline Data
|
|
Explorer.</p>
|
|
|
|
<p>The new project forked off <a
|
|
href="https://github.com/maxogden/recline">Max's original recline
|
|
codebase</a> combining some portions of the <a
|
|
href="http://github.com/okfn/dataexplorer">original Data Explorer</a>.
|
|
However, it has been rewritten from the ground up using Backbone.</p>
|
|
|
|
</div></div> <!-- /span9 /content -->
|
|
<div class="span3 sidebar">
|
|
<div class="well sidebar-nav">
|
|
<h3 class="nav-header">Use the Explorer</h3>
|
|
<p class="getit-btn"><a href="app/" class="btn primary">Visit the Data Explorer »</a></p>
|
|
<h3 class="nav-header">Get the Library</h3>
|
|
<p class="getit-btn"><a href="recline.js" class="btn primary">Development Version<br />v0.3 (67k)</a></p>
|
|
<h4>Dependencies</h4>
|
|
<ul class="deps">
|
|
<li>JQuery >= 1.6</li>
|
|
<li><a href="http://backbonejs.org/">Backbone</a> >= 0.5.1</li>
|
|
<li>Underscore >= 1.0</li>
|
|
<li>JQuery Mustache</li>
|
|
<li><a href="http://code.google.com/p/flot/">JQuery Flot >= 0.7</a>: (Optional) for graphing</li>
|
|
<li><a href="http://leaflet.cloudmade.com/">Leaflet >= 0.3.1</a>: (Optional) for mapping</li>
|
|
<li><a href="http://twitter.github.com/bootstrap/">Bootstrap</a> >= v2.0: (Optional) for CSS/JS</li>
|
|
</ul>
|
|
|
|
<h3 class="nav-header">Documentation</h3>
|
|
<ul class="nav nav-list">
|
|
<li><a href="#docs-using">Using it</a></li>
|
|
<li><a href="#docs-concepts">Concepts and Structure</a></li>
|
|
<li><a href="#docs-source">Source Docs (Docco)</a></li>
|
|
</ul>
|
|
</div><!--/.well -->
|
|
</div><!--/span-->
|
|
</div></div> <!-- /row /container -->
|
|
</body>
|
|
</html>
|