New styling applied
This commit is contained in:
Sam Smith
parent
2a3cca5190
commit
6099fb504c
BIN
css/images/header-screen.png
Normal file
BIN
css/images/header-screen.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 114 KiB |
BIN
css/images/icons/white.png
Normal file
BIN
css/images/icons/white.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.4 KiB |
BIN
css/images/zigzags.png
Normal file
BIN
css/images/zigzags.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.9 KiB |
270
css/site.css
Normal file
270
css/site.css
Normal file
@ -0,0 +1,270 @@
|
||||
/*
|
||||
Theme Name: Recline
|
||||
Description: Layout and styling for reclinejs.com
|
||||
Author: Sam Smith
|
||||
Author URI: http://www.mintcanary.com/
|
||||
*/
|
||||
|
||||
/* --------------------------------------------------
|
||||
Table of Contents
|
||||
-----------------------------------------------------
|
||||
:: General Styles
|
||||
:: Layout
|
||||
::
|
||||
::
|
||||
::
|
||||
*/
|
||||
|
||||
/* ---------------------------------------------------
|
||||
General Styles
|
||||
--------------------------------------------------- */
|
||||
|
||||
@import url(http://fonts.googleapis.com/css?family=Open+Sans:400,400italic,700);
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
font-family:'Open Sans', Helvetica, Arial, sans-serif;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #c7231d;
|
||||
}
|
||||
a:hover {
|
||||
color: #bc130e;
|
||||
}
|
||||
a.dotted {
|
||||
border-bottom-width: 1px;
|
||||
border-bottom-style: dotted;
|
||||
border-bottom-color: #333;
|
||||
color:#333;
|
||||
}
|
||||
a.dotted:hover {
|
||||
text-decoration:none;
|
||||
}
|
||||
|
||||
.btn-info {
|
||||
background: #545454; /* Old browsers */
|
||||
background: -moz-linear-gradient(top, #545454 0%, #454545 100%); /* FF3.6+ */
|
||||
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#545454), color-stop(100%,#454545)); /* Chrome,Safari4+ */
|
||||
background: -webkit-linear-gradient(top, #545454 0%,#454545 100%); /* Chrome10+,Safari5.1+ */
|
||||
background: -o-linear-gradient(top, #545454 0%,#454545 100%); /* Opera 11.10+ */
|
||||
background: -ms-linear-gradient(top, #545454 0%,#454545 100%); /* IE10+ */
|
||||
background: linear-gradient(top, #545454 0%,#454545 100%); /* W3C */
|
||||
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#545454', endColorstr='#454545',GradientType=0 ); /* IE6-9 */
|
||||
border-color: #454545 #454545 #454545;
|
||||
filter: progid:dximagetransform.microsoft.gradient(enabled=false);
|
||||
border: 1px solid #454545;
|
||||
border-bottom-color: #454545;
|
||||
-webkit-border-radius: 4px;
|
||||
-moz-border-radius: 4px;
|
||||
border-radius: 4px;
|
||||
color:#FFF;
|
||||
text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.25);
|
||||
}
|
||||
.btn-info:hover,
|
||||
.btn-info:active,
|
||||
.btn-info.active,
|
||||
.btn-info.disabled,
|
||||
.btn-info[disabled] {
|
||||
background-color: #454545;
|
||||
background-image:none;
|
||||
color:#FFF;
|
||||
}
|
||||
.btn-info:active,
|
||||
.btn-info.active {
|
||||
background-color: #454545 \9;
|
||||
background-image:none;
|
||||
color:#FFF;
|
||||
}
|
||||
|
||||
.btn-large {
|
||||
padding: 9px 14px;
|
||||
-webkit-border-radius: 25px;
|
||||
-moz-border-radius: 25px;
|
||||
border-radius: 25px;
|
||||
margin-right:10px;
|
||||
}
|
||||
|
||||
.btn-primary {
|
||||
background: #c7231d; /* Old browsers */
|
||||
background: -moz-linear-gradient(top, #c7231d 0%, #bc130e 100%); /* FF3.6+ */
|
||||
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#c7231d), color-stop(100%,#bc130e)); /* Chrome,Safari4+ */
|
||||
background: -webkit-linear-gradient(top, #c7231d 0%,#bc130e 100%); /* Chrome10+,Safari5.1+ */
|
||||
background: -o-linear-gradient(top, #c7231d 0%,#bc130e 100%); /* Opera 11.10+ */
|
||||
background: -ms-linear-gradient(top, #c7231d 0%,#bc130e 100%); /* IE10+ */
|
||||
background: linear-gradient(top, #c7231d 0%,#bc130e 100%); /* W3C */
|
||||
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#c7231d', endColorstr='#bc130e',GradientType=0 ); /* IE6-9 */
|
||||
border-color: #0055cc #0055cc #003580;
|
||||
border-color: rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.1) rgba(0, 0, 0, 0.25);
|
||||
filter: progid:dximagetransform.microsoft.gradient(enabled=false);
|
||||
}
|
||||
.btn-primary:hover,
|
||||
.btn-primary:active,
|
||||
.btn-primary.active,
|
||||
.btn-primary.disabled,
|
||||
.btn-primary[disabled] {
|
||||
background-color: #bc130e;
|
||||
background-image:none;
|
||||
}
|
||||
.btn-primary:active,
|
||||
.btn-primary.active {
|
||||
background-color: #bc130e \9;
|
||||
}
|
||||
|
||||
a.btn-large.showtitle[title] {
|
||||
position:relative;
|
||||
margin-bottom:26px;
|
||||
min-width:117px;
|
||||
}
|
||||
a.btn-large.showtitle[title]:after {
|
||||
content: attr(title);
|
||||
position:absolute;
|
||||
bottom:-26px;
|
||||
left:0px;
|
||||
font-size:12px;
|
||||
height:26px;
|
||||
line-height:26px;
|
||||
min-width:145px;
|
||||
text-align:center;
|
||||
}
|
||||
|
||||
.btn-large .icon-large {
|
||||
height:25px;
|
||||
width:25px;
|
||||
margin-top:-2px;
|
||||
margin-left:-25px;
|
||||
margin-right:7px;
|
||||
}
|
||||
.btn-large .icon-white.icon-large {
|
||||
background-image: url(images/icons/white.png);
|
||||
background-repeat: no-repeat;
|
||||
}
|
||||
.btn-large .icon-white.icon-arrow-down.icon-large {
|
||||
background-position: 3px 1px;
|
||||
}
|
||||
.btn-large .icon-white.icon-graph.icon-large {
|
||||
background-position: -50px 4px;
|
||||
}
|
||||
|
||||
/* ---------------------------------------------------
|
||||
Layout
|
||||
--------------------------------------------------- */
|
||||
|
||||
.navbar .brand {
|
||||
font-family:'Open Sans', Helvetica, Arial, sans-serif;
|
||||
font-style:italic;
|
||||
font-size:18px;
|
||||
font-weight:400;
|
||||
letter-spacing:-1px;
|
||||
line-height:40px;
|
||||
}
|
||||
|
||||
.navbar .nav > li > a {
|
||||
padding: 15px 10px;
|
||||
}
|
||||
|
||||
.navbar-inner {
|
||||
height:50px;
|
||||
background: #303030; /* Old browsers */
|
||||
background: -moz-linear-gradient(top, #303030 0%, #2d2d2d 100%); /* FF3.6+ */
|
||||
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#303030), color-stop(100%,#2d2d2d)); /* Chrome,Safari4+ */
|
||||
background: -webkit-linear-gradient(top, #303030 0%,#2d2d2d 100%); /* Chrome10+,Safari5.1+ */
|
||||
background: -o-linear-gradient(top, #303030 0%,#2d2d2d 100%); /* Opera 11.10+ */
|
||||
background: -ms-linear-gradient(top, #303030 0%,#2d2d2d 100%); /* IE10+ */
|
||||
background: linear-gradient(top, #303030 0%,#2d2d2d 100%); /* W3C */
|
||||
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#303030', endColorstr='#2d2d2d',GradientType=0 ); /* IE6-9 */
|
||||
-webkit-box-shadow:none;
|
||||
-moz-box-shadow: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
section {
|
||||
padding-top:20px;
|
||||
}
|
||||
|
||||
.page-header {
|
||||
margin-top:50px;
|
||||
background: #2d2d2d; /* Old browsers */
|
||||
background: -moz-linear-gradient(top, #2d2d2d 0%, #040404 100%); /* FF3.6+ */
|
||||
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#2d2d2d), color-stop(100%,#040404)); /* Chrome,Safari4+ */
|
||||
background: -webkit-linear-gradient(top, #2d2d2d 0%,#040404 100%); /* Chrome10+,Safari5.1+ */
|
||||
background: -o-linear-gradient(top, #2d2d2d 0%,#040404 100%); /* Opera 11.10+ */
|
||||
background: -ms-linear-gradient(top, #2d2d2d 0%,#040404 100%); /* IE10+ */
|
||||
background: linear-gradient(top, #2d2d2d 0%,#040404 100%); /* W3C */
|
||||
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#2d2d2d', endColorstr='#040404',GradientType=0 ); /* IE6-9 */
|
||||
color:#FFF;
|
||||
padding:0px;
|
||||
margin-bottom:0px;
|
||||
border:none;
|
||||
font-family:'Open Sans', Helvetica, Arial, sans-serif;
|
||||
}
|
||||
.page-header a {
|
||||
color:#FFF;
|
||||
}
|
||||
.page-header a.dotted {
|
||||
border-color:#FFF;
|
||||
}
|
||||
.page-header .container {
|
||||
background-image: url(images/header-screen.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: -3px 0px;
|
||||
}
|
||||
.page-header .inner {
|
||||
padding:0px 0px 30px 40px;
|
||||
font-size:16px;
|
||||
}
|
||||
.page-header .inner ol {
|
||||
list-style-type:upper-latin;
|
||||
font-size:20px;
|
||||
font-style:italic;
|
||||
}
|
||||
.page-header .inner .header-button {
|
||||
display:inline-block;
|
||||
}
|
||||
|
||||
.page-header:after {
|
||||
margin-top:-14px;
|
||||
}
|
||||
|
||||
section.grey {
|
||||
background-color:#f5f5f5;
|
||||
}
|
||||
|
||||
section:after {
|
||||
content: " ";
|
||||
height:14px;
|
||||
display:block;
|
||||
background-image: url(images/zigzags.png);
|
||||
background-repeat: repeat-x;
|
||||
background-position: center 1px;
|
||||
}
|
||||
|
||||
section.grey:after {
|
||||
background-position: center -50px;
|
||||
}
|
||||
|
||||
.footer {
|
||||
background-color:#040404;
|
||||
color:#CCC;
|
||||
}
|
||||
.footer:before {
|
||||
content: " ";
|
||||
height:14px;
|
||||
display:block;
|
||||
background-image: url(images/zigzags.png);
|
||||
background-repeat: repeat-x;
|
||||
background-position: center -100px;
|
||||
margin-top:-34px;
|
||||
}
|
||||
.footer:after {
|
||||
display:none;
|
||||
}
|
||||
.footer .row {
|
||||
margin-top:15px;
|
||||
margin-bottom:15px;
|
||||
}
|
||||
.footer a {
|
||||
color:#CCC;
|
||||
}
|
||||
.footer a.btn {
|
||||
color:#333333;
|
||||
}
|
||||
BIN
favicon.ico
Normal file
BIN
favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
BIN
images/logo.png
Normal file
BIN
images/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
BIN
images/screenshot-1.jpg
Normal file
BIN
images/screenshot-1.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 83 KiB |
635
index.html
635
index.html
@ -10,325 +10,356 @@
|
||||
<![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;
|
||||
}
|
||||
<link href="css/site.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
.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">
|
||||
<a class="brand" href="#"><strong>Recline</strong> Data Explorer and Library</a>
|
||||
<ul class="nav pull-right">
|
||||
<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>
|
||||
<section class="page-header">
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
<div class="span8 offset4">
|
||||
<h1>
|
||||
<img src="images/logo.png" width="455" height="190" alt="Recline Data Explorer and Library">
|
||||
</h1>
|
||||
<div class="inner">
|
||||
<ol style="list-style-type:upper-latin;">
|
||||
<li>Powerful data explorer built in pure javascript and html</li>
|
||||
<li>Suite of data components - grid, graphing and data connectors</li>
|
||||
</ol>
|
||||
— All built with <a href="http://backbonejs.org/" class="dotted">Backbone</a>
|
||||
</div>
|
||||
<div class="inner">
|
||||
<a class="btn btn-large btn-info showtitle" href="app/" title="the data explorer"><i class="icon-graph icon-white icon-large"></i>Use It</a>
|
||||
<a class="btn btn-large btn-primary showtitle" href="http://github.com/okfn/recline/" title="code on GitHub"><i class="icon-arrow-down icon-white icon-large"></i>Get It</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="grey">
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
<div class="span12">
|
||||
<h2>Recline is Two Things</h2>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span6">
|
||||
<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>
|
||||
</div>
|
||||
<div class="span6">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<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>
|
||||
</div>
|
||||
<div class="span8">
|
||||
<a href="app/"><img src="images/screenshot-1.jpg" width="632" height="428" alt="Recline Data Explorer Screenshot"></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<p>Recline is two things:</p>
|
||||
<section id="docs">
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
<div class="span12">
|
||||
<h2>Data Explorer Documentation</h2>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span6">
|
||||
<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>
|
||||
</div>
|
||||
<div class="span6">
|
||||
<textarea class="span6"><iframe src="http://okfnlabs.org/recline/app/" width="100%"></iframe></textarea>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span12">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span12">
|
||||
<h2>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>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span12">
|
||||
<h3 id="docs-concepts">Concepts and Structure</h3>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span6">
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<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>
|
||||
<div class="span6">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span12">
|
||||
<h3 id="docs-source">Source Docs (via Docco)</h3>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span6">
|
||||
<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>
|
||||
</div>
|
||||
<div class="span6">
|
||||
<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>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span6">
|
||||
<h2 id="tests">Tests</h2>
|
||||
<p><a href="test/index.html">Run the tests online</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span12">
|
||||
<h2 id="history">History</h2>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="span6">
|
||||
<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>
|
||||
</div>
|
||||
<div class="span6">
|
||||
<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>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<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>
|
||||
<section class="footer">
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
<div class="span3">
|
||||
<h5>Use the Explorer</h5>
|
||||
<p class="getit-btn"><a href="app/" class="btn primary">Visit the Data Explorer »</a></p>
|
||||
<h5>Get the Library</h5>
|
||||
<p class="getit-btn"><a href="recline.js" class="btn primary">Development Version<br />v0.3 (67k)</a></p>
|
||||
</div>
|
||||
<div class="span3">
|
||||
<h5>Dependencies</h5>
|
||||
<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>
|
||||
</div>
|
||||
<div class="span3">
|
||||
<h5>Documentation</h5>
|
||||
<ul>
|
||||
<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>
|
||||
<div class="span3">
|
||||
<h5>Contacts</h5>
|
||||
<ul>
|
||||
<li><a href="http://twitter.com/maxogden">@maxogden</a></li>
|
||||
<li><a href="http://twitter.com/rufuspollock">@rufuspollock</a></li>
|
||||
</ul>
|
||||
<a class="nav-logo" 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>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<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>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user