[refactor,docs][xs]: indentation and text-wrap.
This commit is contained in:
97
index.html
97
index.html
@@ -77,8 +77,9 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="container"><div class="row">
|
<div class="container">
|
||||||
<div class="span9"><div class="content">
|
<div class="row"><div class="span9"><div class="content">
|
||||||
|
|
||||||
<div class="page-header">
|
<div class="page-header">
|
||||||
<h1>
|
<h1>
|
||||||
Recline Data Explorer and Library<br />
|
Recline Data Explorer and Library<br />
|
||||||
@@ -90,19 +91,21 @@
|
|||||||
— All built on <a href="http://backbonejs.org/">Backbone</a></small>
|
— All built on <a href="http://backbonejs.org/">Backbone</a></small>
|
||||||
</h1>
|
</h1>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<p>Recline is two things:</p>
|
<p>Recline is two things:</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>A Data Explorer combining a data grid, Google Refine-style data
|
<li>A Data Explorer combining a data grid, Google Refine-style data
|
||||||
transforms and visualizations all in lightweight javascript and html.</li>
|
transforms and visualizations all in lightweight javascript and html.</li>
|
||||||
<li>A simple but powerful library of extensible of data components - data
|
<li>A simple but powerful library of extensible of data components - data
|
||||||
grid, graphing, and data connectors - which you can selectively use and
|
grid, graphing, and data connectors - which you can selectively use and build
|
||||||
build on.</li>
|
on.</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<p>The Explorer can be used standalone (just download and use) or can be
|
<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
|
embedded into your own site. Recline builds on the powerful but lightweight
|
||||||
Backbone framework making it extremely easy to extend and adapt. The
|
Backbone framework making it extremely easy to extend and adapt. The library's
|
||||||
library's modular design mean means you only have to take what you
|
modular design mean means you only have to take what you need.</p>
|
||||||
need.</p>
|
|
||||||
|
|
||||||
<h2 id="features">Main Features</h2>
|
<h2 id="features">Main Features</h2>
|
||||||
<ul>
|
<ul>
|
||||||
@@ -127,23 +130,30 @@
|
|||||||
<p><a href="app/index.html" class="btn">For demo see the Data Explorer »</a></p>
|
<p><a href="app/index.html" class="btn">For demo see the Data Explorer »</a></p>
|
||||||
|
|
||||||
<h2 id="docs">Data Explorer Documentation</h2>
|
<h2 id="docs">Data Explorer Documentation</h2>
|
||||||
|
|
||||||
<p>Usage instructions are built into the <a href="app/">Data Explorer</a>
|
<p>Usage instructions are built into the <a href="app/">Data Explorer</a>
|
||||||
itself so no specific additional documentation is provided on usage.</p>
|
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>
|
<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>
|
<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
|
<p>Alternatively, you can initialize the explorer yourself from javascript. To
|
||||||
in: <a href="app/js/app.js">app.js</a>.</p>
|
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>
|
<h2 id="docs">Library Documentation</h2>
|
||||||
|
|
||||||
<h3 id="docs-using">Examples</h3>
|
<h3 id="docs-using">Examples</h3>
|
||||||
|
|
||||||
<p><strong>Note:</strong> A quick read through of the Concepts section will
|
<p><strong>Note:</strong> A quick read through of the Concepts section will
|
||||||
likely be useful in understanding the details of the examples.</p>
|
likely be useful in understanding the details of the examples.</p>
|
||||||
|
|
||||||
<p><strong>Note</strong>: for all the following examples you should have
|
<p><strong>Note</strong>: for all the following examples you should have
|
||||||
included relevant Recline dependencies.</p>
|
included relevant Recline dependencies.</p>
|
||||||
|
|
||||||
<h4>Simple in-memory dataset.</h4>
|
<h4>Simple in-memory dataset.</h4>
|
||||||
<pre>
|
<pre>
|
||||||
// Some data you have
|
// Some data you have
|
||||||
@@ -193,31 +203,42 @@ var dataset = recline.Model.Dataset({
|
|||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
<h3 id="docs-concepts">Concepts and Structure</h3>
|
<h3 id="docs-concepts">Concepts and Structure</h3>
|
||||||
|
|
||||||
<p>Recline has a simple structure layered on top of the basic Model/View
|
<p>Recline has a simple structure layered on top of the basic Model/View
|
||||||
distinction inherent in Backbone.</p>
|
distinction inherent in Backbone.</p>
|
||||||
|
|
||||||
<p><strong>Models</strong>: there are two main model objects:</p>
|
<p><strong>Models</strong>: there are two main model objects:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="docs/model.html#section-2">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#section-2">Dataset</a>: represents the dataset.
|
||||||
<li><a href="docs/model.html#section-4">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>
|
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#section-4">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>
|
</ul>
|
||||||
<p>More detail of how these work can be found in the <a href="docs/model.html">Model source docs</a>.</p>
|
|
||||||
|
|
||||||
<p><strong>Backends</strong> connect Dataset and Documents to data
|
<p>More detail of how these work can be found in the <a
|
||||||
from a specific 'Backend' data source. They provide methods for loading and
|
href="docs/model.html">Model source docs</a>.</p>
|
||||||
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>
|
|
||||||
|
|
||||||
<p><strong>Views</strong>: complementing the model are various Views (you can also easily write your own). Each view holds a pointer to a Dataset:</p>
|
<p><strong>Backends</strong> 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>
|
||||||
|
|
||||||
|
<p><strong>Views</strong>: complementing the model are various Views (you can
|
||||||
|
also easily write your own). Each view holds a pointer to a Dataset:</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li>DataExplorer: the parent view which manages the overall app and sets up sub views.</li>
|
<li>DataExplorer: the parent view which manages the overall app and sets up
|
||||||
|
sub views.</li>
|
||||||
<li>DataGrid: the data grid view.</li>
|
<li>DataGrid: the data grid view.</li>
|
||||||
<li>FlotGraph: a simple graphing view using <a href="http://code.google.com/p/flot/">Flot</a>.</li>
|
<li>FlotGraph: a simple graphing view using <a
|
||||||
|
href="http://code.google.com/p/flot/">Flot</a>.</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h3 id="docs-source">Source Docs (via Docco)</h3>
|
<h3 id="docs-source">Source Docs (via Docco)</h3>
|
||||||
@@ -237,16 +258,18 @@ var dataset = recline.Model.Dataset({
|
|||||||
<p><a href="test/index.html">Run the tests online</a>.</p>
|
<p><a href="test/index.html">Run the tests online</a>.</p>
|
||||||
|
|
||||||
<h2 id="history">History</h2>
|
<h2 id="history">History</h2>
|
||||||
<p>Max Ogden was developing Recline as the frontend data browser and editor
|
<p>Max Ogden was developing Recline as the frontend data browser and editor for
|
||||||
for his <a href="http://datacouch.com/">http://datacouch.com/</a> project.
|
his <a href="http://datacouch.com/">http://datacouch.com/</a> project.
|
||||||
Meanwhile, Rufus Pollock and the <a href="http://ckan.org/">CKAN team</a>
|
Meanwhile, Rufus Pollock and the <a href="http://ckan.org/">CKAN team</a> at
|
||||||
at the <a href="http://okfn.org/">Open Knowledge Foundation</a> had been
|
the <a href="http://okfn.org/">Open Knowledge Foundation</a> had been working
|
||||||
working on a <a href="http://github.com/okfn/dataexplorer">Data
|
on a <a href="http://github.com/okfn/dataexplorer">Data Explorer</a> for use in
|
||||||
Explorer</a> for use in <a href="http://thedatahub.org">the DataHub</a>
|
<a href="http://thedatahub.org">the DataHub</a> and <a
|
||||||
and <a href="http://ckan.org/">CKAN software</a>.</p>
|
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
|
<p>When they met up, they realized that they were pretty much working on the
|
||||||
Data Explorer.</p>
|
same thing and so decided to join forces to produce the new Recline Data
|
||||||
|
Explorer.</p>
|
||||||
|
|
||||||
<p>The new project forked off <a
|
<p>The new project forked off <a
|
||||||
href="https://github.com/maxogden/recline">Max's original recline
|
href="https://github.com/maxogden/recline">Max's original recline
|
||||||
codebase</a> combining some portions of the <a
|
codebase</a> combining some portions of the <a
|
||||||
|
|||||||
Reference in New Issue
Block a user