From 5313fde8aaba1b9a72991562a611ad3b1fd0569e Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Sat, 17 Mar 2012 18:46:27 +0000 Subject: [PATCH] [#52,docs][s]: create sidebar in main docs and do various other minor bits of tidying. * Also link back to main page / docs from demo. --- demo/index.html | 5 ++- index.html | 90 ++++++++++++++++++++++++++++++------------------- 2 files changed, 60 insertions(+), 35 deletions(-) diff --git a/demo/index.html b/demo/index.html index a99181de..3205aee9 100644 --- a/demo/index.html +++ b/demo/index.html @@ -48,7 +48,10 @@
- Recline Data Explorer + Recline Data Explorer Demo + diff --git a/index.html b/index.html index 699c9540..1f1c298a 100644 --- a/index.html +++ b/index.html @@ -11,13 +11,14 @@ + -Fork me on GitHub
@@ -52,8 +65,8 @@

Backbone

-

Recline combines a data grid, Google Refine-style data transforms - and visualizations all in lightweight javascript and html.

+

Recline combines a data grid, Google Refine-style data transforms + and visualizations all in lightweight javascript and html.

Designed for standalone use or as a library to integrate into your own app. Recline builds on the powerful but lightweight Backbone framework - making it extremely easy to extend and adapt.

+ making it extremely easy to extend and adapt and its modular design means you only have to take what you need.

Main Features

    @@ -95,25 +109,13 @@

Screenshots

- Recline Data Explorer Screenshot +

Recline Data Explorer Screenshot

Demo

For Recline Demo Click Here »

-

Downloads & Dependencies (Right-click, and use 'Save As')

-

Recline Current Version (v0.3) »

-

Dependencies

-

Javascript Libraries:

-
    -
  • Jquery >= 1.6
    • -
  • Underscore and Backbone (0.5.1)
    • -
  • JQuery Mustache
    • -
  • (Optional) JQuery Flot - for graphing
    • -
-

CSS: the demo utilizes bootstrap but you can integrate with your own HTML and CSS. Data Explorer specific CSS can be found here in the repo: https://github.com/okfn/recline/tree/master/css.

-

Documentation

-

Quickstart

+

Quickstart

 // Note: you should have included the relevant JS libraries (and CSS)
 // See above for dependencies
@@ -138,12 +140,14 @@ Backbone.history.start();
       href="demo/">Demo -- just hit view source (NB: the javascript for the
     demo is in: app.js).

 
-    
Architecture and Model

+    
Structure

     
Recline has a simple structure layered on top of the basic Model/View
-    distinction inherent in Backbone. There are the following two main domain objects (both Backbone Models):

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

 
@@ -153,18 +157,14 @@ Backbone.history.start();
     query API and doing bulk transforms on the backend. More info on backends can be found below.

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

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

 
-
 
Backends

-
-
Backends are connectors to backend data sources from which data can be retrieved.

-
 
Backends are implemented as Backbone models but this is just a convenience
 (they do not save or load themselves from any remote source). You can see
 detailed examples of backend implementation in the source documentation
@@ -239,7 +239,29 @@ like).

       href="http://github.com/okfn/dataexplorer">original Data Explorer.
     However, it has been rewritten from the ground up using Backbone.

 
-
-
+
+
+
+

Get It

+

Development Version
v0.3 (67k)

+

Dependencies

+ + +

Documentation

+ +
+
+