knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs][xs]: linewrap.

Browse Source
This commit is contained in:
Rufus Pollock
2012-07-08 12:58:05 +01:00
parent b19eb18cd3
commit 3ad97a82e0
1 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/tutorial-backends.markdown
View File

@@ -17,8 +17,10 @@ sources such as Google Docs or the DataHub using Recline</small>
<div class="alert alert-info"> <div class="alert alert-info">
<p><strong>Note</strong>: often you are loading data from a given source in <p><strong>Note</strong>: often you are loading data from a given source in
order to load it into a Recline Dataset and display it in a View. However, you can also order to load it into a Recline Dataset and display it in a View. However, you
happily use a Backend to load data on its own without using any other part of the Recline library as all the Backends are designed to have no dependency on other parts of Recline.</p> can also happily use a Backend to load data on its own without using any other
part of the Recline library as all the Backends are designed to have no
dependency on other parts of Recline.</p>
</div> </div>
## Overview ## Overview
@@ -34,7 +36,8 @@ You can use a backend directly e.g.
var backend = recline.Backend.ElasticSearch.fetch({url: ...}); var backend = recline.Backend.ElasticSearch.fetch({url: ...});
{% endhighlight %} {% endhighlight %}
But more usually the backend will be created or loaded for you by Recline and all you need is provide the identifier for that Backend e.g. But more usually the backend will be created or loaded for you by Recline and
all you need is provide the identifier for that Backend e.g.
{% highlight javascript %} {% highlight javascript %}
var dataset = recline.Model.Dataset({ var dataset = recline.Model.Dataset({
@@ -44,7 +47,10 @@ var dataset = recline.Model.Dataset({
<div class="alert alert-info"> <div class="alert alert-info">
<strong>Backend identifiers</strong> <strong>Backend identifiers</strong>
How do you know the backend identifier for a given Backend? It's just the name of the 'class' in recline.Backend module (but case-insensitive). E.g. recline.Backend.ElasticSearch can be identified as 'ElasticSearch' or 'elasticsearch'. How do you know the backend identifier for a given Backend? It's just the name
of the 'class' in recline.Backend module (but case-insensitive). E.g.
recline.Backend.ElasticSearch can be identified as 'ElasticSearch' or
'elasticsearch'.
</div> </div>
### Included Backends ### Included Backends
@@ -54,11 +60,13 @@ How do you know the backend identifier for a given Backend? It's just the name o
* [gdocs: Google Docs (Spreadsheet) Backend](docs/backend/gdocs.html) * [gdocs: Google Docs (Spreadsheet) Backend](docs/backend/gdocs.html)
* [csv: Local CSV file backend](docs/backend/csv.html) * [csv: Local CSV file backend](docs/backend/csv.html)
Backend not on this list that you would like to see? It's very easy to write a new backend -- see below for more details. Backend not on this list that you would like to see? It's very easy to write a
new backend -- see below for more details.
## Preparing your app ## Preparing your app
This is as per the [quickstart](tutorial-views.html) but the set of files is much more limited if you are just using a Backend. Specifically: This is as per the [quickstart](tutorial-views.html) but the set of files is
much more limited if you are just using a Backend. Specifically:
{% highlight html %} {% highlight html %}
<!-- 3rd party dependencies --> <!-- 3rd party dependencies -->