From 2b8f1bcf6450b8e5d069322c7a543e44c33641d1 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Wed, 4 Apr 2012 10:53:50 +0100 Subject: [PATCH] [refactor,docs][xs]: indentation and text-wrap. --- index.html | 261 +++++++++++++++++++++++++++++------------------------ 1 file changed, 142 insertions(+), 119 deletions(-) diff --git a/index.html b/index.html index 2f707218..80828a33 100644 --- a/index.html +++ b/index.html @@ -77,75 +77,85 @@ -
-
-
-

- Recline Data Explorer and Library
- - A. Powerful data explorer using only javascript and html -
- B. Suite of data components - grid, graphing and data connectors -
- — All built on Backbone -

-
-

Recline is two things:

-
    -
  • A Data Explorer combining a data grid, Google Refine-style data - transforms and visualizations all in lightweight javascript and html.
    • -
  • A simple but powerful library of extensible of data components - data - grid, graphing, and data connectors - which you can selectively use and - build on.
    • -
-

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.

+
+
-

Main Features

-
    -
  • View and edit your data in a clean grid / table interface
    • -
  • Bulk update/clean your data using an easy scripting UI
    • -
  • Easily extensible with new Backends so you can connect to your - database or storage layer
    • -
  • Visualize data
    • -
  • Open-source, pure javascript and designed for integration -- so it is - easy to embed in other sites and applications
    • -
  • Built on the simple but powerful Backbone giving a - clean and robust design which is easy to extend
    • -
  • Properly designed model with clean separation of data and presentation
    • -
  • Componentized design means you use only what you need
    • -
+
+

+ Recline Data Explorer and Library
+ + A. Powerful data explorer using only javascript and html +
+ B. Suite of data components - grid, graphing and data connectors +
+ — All built on Backbone +

+
-

Screenshots

-

Recline Data Explorer Screenshot

+

Recline is two things:

-

Demo

-

For demo see the Data Explorer »

+
    +
  • A Data Explorer combining a data grid, Google Refine-style data + transforms and visualizations all in lightweight javascript and html.
    • +
  • A simple but powerful library of extensible of data components - data + grid, graphing, and data connectors - which you can selectively use and build + on.
    • +
-

Data Explorer Documentation

-

Usage instructions are built into the Data Explorer - itself so no specific additional documentation is provided on usage.

-

To embed the data explorer in another site you can use a simple iframe - in your web page:

- -

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: app.js.

+

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.

+ +

Main Features

+
    +
  • View and edit your data in a clean grid / table interface
    • +
  • Bulk update/clean your data using an easy scripting UI
    • +
  • Easily extensible with new Backends so you can connect to your + database or storage layer
    • +
  • Visualize data
    • +
  • Open-source, pure javascript and designed for integration -- so it is + easy to embed in other sites and applications
    • +
  • Built on the simple but powerful Backbone giving a + clean and robust design which is easy to extend
    • +
  • Properly designed model with clean separation of data and presentation
    • +
  • Componentized design means you use only what you need
    • +
+ +

Screenshots

+

Recline Data Explorer Screenshot

+ +

Demo

+

For demo see the Data Explorer »

+ +

Data Explorer Documentation

+ +

Usage instructions are built into the Data Explorer +itself so no specific additional documentation is provided on usage.

+ +

To embed the data explorer in another site you can use a simple iframe in +your web page:

+ + + +

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: app.js.

-

Library Documentation

+

Library Documentation

-

Examples

-

Note: A quick read through of the Concepts section will - likely be useful in understanding the details of the examples.

-

Note: for all the following examples you should have - included relevant Recline dependencies.

-

Simple in-memory dataset.

- 
+
Examples

+
+
Note: A quick read through of the Concepts section will
+likely be useful in understanding the details of the examples.

+
+
Note: for all the following examples you should have
+included relevant Recline dependencies.

+
+
Simple in-memory dataset.

+
 // 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
@@ -170,7 +180,7 @@ var explorer = recline.View.DataExplorer({
 Backbone.history.start();
 

 
-    
Creating a Dataset Explicitly with a Backend

+
Creating a Dataset Explicitly with a Backend

 
 // Backend can be an instance or string id for a backend in the
 // recline.Model.backends registry
@@ -192,66 +202,79 @@ var dataset = recline.Model.Dataset({
 );
 

 
-    
Concepts and Structure

-    
Recline has a simple structure layered on top of the basic Model/View
-    distinction inherent in Backbone.

-    
-    
Models: there are two main model objects:

-    
    
-      
  • Dataset: 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.
    • 
-      
  • Document: 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).
    • 
-    

-    
More detail of how these work can be found in the Model source docs.

+
Concepts and Structure

 
-    
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.

-    
A template Base class can be found in
-      the Backend base module of the source docs. 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.

-    
-    
Views: complementing the model are various Views (you can also easily write your own). Each view holds a pointer to a Dataset:

-    
    
-      
  • DataExplorer: the parent view which manages the overall app and sets up sub views.
    • 
-      
  • DataGrid: the data grid view.
    • 
-      
  • FlotGraph: a simple graphing view using Flot.
    • 
-    

+
Recline has a simple structure layered on top of the basic Model/View
+distinction inherent in Backbone.

 
-    
Source Docs (via Docco)

-    
+
Models: there are two main model objects:

+
    
+  
  • Dataset: 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.
    • 
+  
  • Document: 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).
    • 
+

 
-    
Tests

-    
Run the tests online.

+
More detail of how these work can be found in the Model source docs.

 
-    
History

-    
Max Ogden was developing Recline as the frontend data browser and editor
-    for his http://datacouch.com/ project.
-    Meanwhile, Rufus Pollock and the CKAN team
-    at the Open Knowledge Foundation had been
-    working on a Data
-      Explorer for use in the DataHub
-    and CKAN software.

-    
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.

-    
The new project forked off Max's original recline
-      codebase combining some portions of the original Data Explorer.
-    However, it has been rewritten from the ground up using Backbone.

+
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.

+
+
A template Base class can be found in the
+  Backend base module of the source docs. 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.

+
+
Views: complementing the model are various Views (you can
+also easily write your own). Each view holds a pointer to a Dataset:

+
    
+  
  • DataExplorer: the parent view which manages the overall app and sets up
+  sub views.
    • 
+  
  • DataGrid: the data grid view.
    • 
+  
  • FlotGraph: a simple graphing view using Flot.
    • 
+

+
+
Source Docs (via Docco)

+
+
+
Tests

+
Run the tests online.

+
+
History

+
Max Ogden was developing Recline as the frontend data browser and editor for
+his http://datacouch.com/ project.
+Meanwhile, Rufus Pollock and the CKAN team at
+the Open Knowledge Foundation had been working
+on a Data Explorer for use in
+the DataHub and CKAN software.

+
+
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.

+
+
The new project forked off Max's original recline
+  codebase combining some portions of the original Data Explorer.
+However, it has been rewritten from the ground up using Backbone.