From 51ff83646c6740e694f16b37cc966328662f7668 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Tue, 3 Apr 2012 21:23:21 +0100 Subject: [PATCH 1/8] [demo/style/images][xs]: remove long obsolete and unused images. --- demo/style/images/down-arrow.png | Bin 971 -> 0 bytes demo/style/images/edit-map.png | Bin 1569 -> 0 bytes demo/style/images/loader-blue.gif | Bin 1343 -> 0 bytes demo/style/images/loader.gif | Bin 1413 -> 0 bytes demo/style/images/menu-dropdown.png | Bin 1123 -> 0 bytes 5 files changed, 0 insertions(+), 0 deletions(-) delete mode 100755 demo/style/images/down-arrow.png delete mode 100755 demo/style/images/edit-map.png delete mode 100755 demo/style/images/loader-blue.gif delete mode 100755 demo/style/images/loader.gif delete mode 100755 demo/style/images/menu-dropdown.png diff --git a/demo/style/images/down-arrow.png b/demo/style/images/down-arrow.png deleted file mode 100755 index f172a16234ca91c04ffc9d7cddd898870d6f3620..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 971 zcmaJ=J#W)M7(Nk*N>L>`mZc{b!P5AX#I+Su1v{ojaTFzy$QZ}IBvxvlu`k5QgeoyG zqy7uTiUb1)vG5NNI}1p3La@O(O;QGeCHwAu^*qn}>1U1l{jJR#n*e|<>&R%*^D2Gw z8#(&DwPXCG#}27>NDKGL#EB88c({k46*vRbM2IeYV#fxf3P4~sT$M>-n%N3$5UX7#o^8@Y^b|SGj9&m!9D4B*R7AT^SOhe+N zg)rG$Di|nnV?QE34q>L~^zfKy49)bsgdkeUhRLE$v|(K8M4Z6#SxHNvZT}w{1S@nx zn&=|me+nnEQZ%S*S?WW8@GVw=q6mcCj(U1SdlrLA_Okw&VI?X3z1q zty*D1oX|y#fg4Ud!cZGF&#;zXrW@(e25utF@)Z zYVlD>w>_q7J*=EPrN2bJQEOKvN&5Ev*N@llKT*#m(yX_BgDh(^axcK`ucx(Z6bh_r-FSJgd-4ZJH!76? diff --git a/demo/style/images/edit-map.png b/demo/style/images/edit-map.png deleted file mode 100755 index dea0ed1ef4e1a8d301f58c9a24ce7ed3ea297bb6..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1569 zcmeAS@N?(olHy`uVBq!ia0vp^MnEjU!3HElqIG(Jlw^r(L`iUdT1k0gQ7VIDN`6wR zf@f}GdTLN=VoGJ<$y6H#24v4 zq}24xJX@vryZ0+8WTx0Eg`4^s_!c;)W@LI)6{QAO`Gq7`WhYyvDB0U7*i={n4aiL` zNmQuF&B-gas<2f8n`;GRgM{^!6u?SKvTcwn`Gtf;oFf&jvGt@IQ zHZeCh*HJJsFf`CNFw!?P(ls=ndS0-B(gnVDi`Y3yQQ>}q7{VqjotXz1c*X=!fZ;%w&ZVrt;# zXl&>R)9aF-T$-DjR|3v4~Pj*wm=R%;iu*SQ+p9GSx?XmOJ`tUn(FD|7*cU7 z>CgZF_J<1?bQF?q9W(#tu!_6m?23$UnhJWSKZ#p%JhBkKzi_5(b#*A;CI{9qhK(#! znNRX$ty8gmlhDL9A%)RkiX=~{rQwY?YkGL1xMWUvsTOSDWJ=HgMh9oohDyts5;ZzM z4BjLxH1RN#{e9xY%iHz_w+}Y3zmQaG%jT~OFumcOZkJr~@0lKpccGqNlVi|~sSoe0&FAs$jx(tF_mAJT=IFlf8dXZNtP*^2 ze-0gB=&4jT)!PuUYP-SVH*50~y<%ogF#Qqv(Rk0lAM7%x7Njt7CC)f}h~K z$Bs$o@BK~u!DJ%cl4!`n`qbwI->;wCLd*+h1WZe6KRtK%-`1hW%Y2!BWZ4a&gi$?sGPuetgw8Sf*;h z?XxWX;v}t|4V;!PjvE~l9gaM%CaJb>8OCt&WB73QrJ#wOUN}&b*PE)d9Y`Z&QUg>?-MS)IMAw}aDM0P zPls%~w8b1x21#$_aAQn0p4VhtQoc*%#>EX=_`LkK%l~IcubAOpcvMLva*^mko}LA2 zTpQAsM_RK+oHuaFE}M0eaaDSP;io3IvONb5F54#CW6*zu@uRF(bOC#o9y2f<$>^<( gS8GdTVqoH7aNjQEEY|+vJ*d$3boFyt=akR{0GM<+9{>OV diff --git a/demo/style/images/loader-blue.gif b/demo/style/images/loader-blue.gif deleted file mode 100755 index 45b49052eb4b92428e751766e45816773cd45842..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1343 zcmb`HUq};i9Ke6u-A-Lon;qAx%eHaputUs-SdG}9+d0?p?K#jo)^PYR<9&QW`)kE ztv<+Z6L10-!jmj7am})=wu33+#Qs@ki{LvjAYF_L$0ls`A=CF|Wp1I`<*0BM<`-Zp zgplboo<<-XvG5E-=n&Ef#;3jbb2&E})T-Byol?c_tEzLaQg>P|*RhVx!JN^wSfwAC z&&*iRxsm*Gee^Z5@M$K;hlL~F^ta4Lj4peBZTi(adG2^u$@O!>T#m(J`uQTw;){9~ zX`5xz%mT17cOfT5;=V&sT^0?~1GcqnKM(?dE`wxw5qRi48{mNjfCp?bJjt~VkY+0g z0#sjTlw8e#5#R@AFv1l16uPDU5xZhecX2@=bhodnMRmCFk>tk5wT5S2EMRchFWiev z-|8qD%tX}|38hIU6tJXpouo1Q$_IX`MSrAipEec8g%oc;l~E&>xY{(CD-balb~;z3 zS33Un6-xM;NY+8;Siu+U9|B3%0Y-4G4io@C7y(nsQa}Xg15MC{A{PW5iYC(Vfl$y2 zDS;y}rKxSupXzzQ?1}dAHTt?dKD*(?OCLskRGprFh$`fqKHOY+6BUeZk7A$3M@D)Z zxh6SlFzzyTqIPqf2n6QYyurq!w?)s5C*kQ-*~{otHiUky{*T6ztDjJ2Y?hOu!;HyY z!*nnv5J2CsYiK~p8d@KohpVtw?T3+-*5OW|^;RWrm>qy11||CN6!-vW5VO<^U;IC! z*6!pyMm}8frn#V)zA}@F*)?6x-Z#Q|Px1K98P%L4Bjzq&FvX2{_mhpWao47y$ID$k z#xc?ztfjKmNL!k|c6W_d!Xe*mqmgt@Rw8t zhPcFu2%QsTHv3x@_)|V0iO+&^UKFhy$2R5rK<9IdXiNP>)Wy{N4x>Mz%0r(S+ODyG zHJ)9g_Rkzdba}X86L}1szzEfj!~NPKq#pGWgxsxOFxar&O$H)G@7cSK@~>UtEUgz% UD#5u8RQf7a)1`{DP6yih1MQt(r~m)} diff --git a/demo/style/images/loader.gif b/demo/style/images/loader.gif deleted file mode 100755 index 4a16dea3604ba668fe9faf7ca389206883501c81..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1413 zcmcK4ZAcSw00!{?wsWsH@l0#Zxwf@LQbKKpmEhi-tIU^NrY5muN`=&{Ard1lnPO(9 zwqB?aSt}|=Z%9P=L1UDZgoFfzM8%2nkg-D8i&ran$NsvMIqCO!K+(V1xAOu$v|ns_=9c@r7BH>CX`D=l(V zT1@3dxht~;JVJ=}J0%g41d@f{I0Q{dT&YIi6WO_Z+n1W{k~nfcpAGiagy=xQf#Vyk zx_&}m;2X)UPMY16SkB~W6h?FSvnk`4z?qY~p}?;=6s#cpUC)pDJ~$FvgO8K>zaO#e z?<3k{Ioo{U`(dliijxH|1aU;f%UY4;@AprCnNC`qgfJjLlBV5FNYdTaJ$QT2u-bq~ zb+vT}%rS9BAOH}URB9EBVgxUL5zI#6Qn0olmTuuL;g;b(x1-b3VILrDufAO;BR93i zULCn|dzg;5v|Y+c)Z0>7+i9M-H=eZ1o#GqKJ=qjFTU@i$lB$+2T3+L_B+yBfL@q5` zDj-bRkrbZY^jk_bN9tE2V1ZHuF9#6@Q8^bdfd+7RwAVNM0EO&-$0{A} zblbCR!V_J^cU8)C_I>(zGhduCqN_dHn(iO)WqPQUX6r+zU0it5c2V-$kXdo$tJY;N zTq4|RNtSJ^*s8Gz6pTnI_1cb`{}Acs5dFJ6v`3$=M>Nz08Ic!NgByy1j|r*+1VgTY z`3>uMGEVp+HyjBijvdPq$Q_x HCbI4)eWJZy diff --git a/demo/style/images/menu-dropdown.png b/demo/style/images/menu-dropdown.png deleted file mode 100755 index c733fef7f4b2c5249752673204f7c604a453e5dd..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1123 zcmaJ=T}TvB7#&i`EEOw??4fB4GHB;--Q9L_6Wwuh%h|TwiL9r_nd|PL^W)659epYC zA&jWBf?k4pi--y`kqWHd0v}3yDkYM%AT%_DQpE0WCqb&W7-G{cN!0jx$bngAZvq!dU1N$F^N1*$MC zk5I)%*eEn`vZ0ZZiy};*|zO;1c)$qdPQ_dV_1TCw?>6c=0j zo^83cX8Y0W?dym7FN~9Sd#+qfC5nf4c649rK0MvCS=g4m?4%BTE@8d9HjNaJZPT@F zrIjzbVp2iHN$UK={O^y()*WF7-t71^_vB{uL$kPh@#EmdGh^g)?B3(G&r+Qy_9Hu3 Mv@XWquRV3{7e{)Hj{pDw From b0fae7c3d032f9cc70d60c139ec22c43846fb9f6 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Tue, 3 Apr 2012 21:54:22 +0100 Subject: [PATCH 2/8] [#65,refactor][s]: move demo to app and rework mains docs to reflect app / library distinction. --- {demo => app}/built.html | 0 {demo => app}/images/bg_gradient.gif | Bin {demo => app}/images/couch.png | Bin {demo => app}/images/large-spinner.gif | Bin {demo => app}/index.html | 6 ++-- {demo => app}/js/app.js | 0 {demo => app}/style/demo.css | 0 index.html | 43 +++++++++++++++++-------- 8 files changed, 32 insertions(+), 17 deletions(-) rename {demo => app}/built.html (100%) rename {demo => app}/images/bg_gradient.gif (100%) rename {demo => app}/images/couch.png (100%) rename {demo => app}/images/large-spinner.gif (100%) rename {demo => app}/index.html (96%) rename {demo => app}/js/app.js (100%) rename {demo => app}/style/demo.css (100%) diff --git a/demo/built.html b/app/built.html similarity index 100% rename from demo/built.html rename to app/built.html diff --git a/demo/images/bg_gradient.gif b/app/images/bg_gradient.gif similarity index 100% rename from demo/images/bg_gradient.gif rename to app/images/bg_gradient.gif diff --git a/demo/images/couch.png b/app/images/couch.png similarity index 100% rename from demo/images/couch.png rename to app/images/couch.png diff --git a/demo/images/large-spinner.gif b/app/images/large-spinner.gif similarity index 100% rename from demo/images/large-spinner.gif rename to app/images/large-spinner.gif diff --git a/demo/index.html b/app/index.html similarity index 96% rename from demo/index.html rename to app/index.html index bfd45a5f..059c1f89 100644 --- a/demo/index.html +++ b/app/index.html @@ -2,8 +2,8 @@ - Recline Data Explorer Demo - + Recline Data Explorer + @@ -49,7 +49,7 @@ -
-
- -

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

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.