[docs][m]: create docs for model and view using docco and link from index page.

This commit is contained in:
Rufus Pollock
2012-01-26 15:19:07 +00:00
parent 3dcbe31e9d
commit 8115236d1a
4 changed files with 1247 additions and 7 deletions

View File

@@ -68,11 +68,14 @@
<h2>Main Features</h2>
<ul>
<li>Open-source (and heavy reuser of existing open-source libraries like Backbone)</li>
<li>Pure javascript (no Flash) and designed for integration -- so it is easy to embed in other sites and applications</li>
<li>Open-source (and heavy reuser of existing open-source libraries like
Backbone)</li>
<li>Pure javascript (no Flash) and designed for integration -- so it is
easy to embed in other sites and applications</li>
<li>View and edit your data in a clean grid 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>Easily extensible with new Backends so you can connect to your
database or storage layer</li>
<li>Visualize data</li>
</ul>
@@ -82,12 +85,27 @@
</ul>
<h2>Docs</h2>
<p>Coming soon!</p>
<p>Want to see how to embed this in your own application. Check out the the
<a href="demo/">Demo</a> and view source.</p>
<ul>
<li><a href="docs/model.html">Model and Backends</a></li>
<li><a href="docs/view.html">Views including the main Data Explorer</li>
</ul>
<h2>History</h2>
<p>Max Ogden was developing Recline as the frontend data browser and editor 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 was rapidly rewritten from the ground up using Backbone.</p>
<p>Max Ogden was developing Recline as the frontend data browser and editor
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 was rapidly rewritten from the ground up using Backbone.</p>
</div>
</div>