1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to JIO’s documentation! — JIO 2.0.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '2.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="JIO 2.0.0 documentation" href="#" />
<link rel="next" title="Introduction" href="introduction.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="introduction.html" title="Introduction"
accesskey="N">next</a> |</li>
<li><a href="#">JIO 2.0.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="welcome-to-jio-s-documentation">
<h1>Welcome to JIO’s documentation!<a class="headerlink" href="#welcome-to-jio-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#what-is-jio">What is jIO?</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#how-does-it-work">How does it work?</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#getting-started">Getting started</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="download.html">Downloads</a><ul>
<li class="toctree-l2"><a class="reference internal" href="download.html#minified-version">Minified version</a></li>
<li class="toctree-l2"><a class="reference internal" href="download.html#fork">Fork</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="manage_documents.html">How to manage documents?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="manage_documents.html#what-is-a-document">What is a document?</a></li>
<li class="toctree-l2"><a class="reference internal" href="manage_documents.html#basic-methods">Basic Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="manage_documents.html#promises">Promises</a></li>
<li class="toctree-l2"><a class="reference internal" href="manage_documents.html#method-options-and-callback-responses">Method Options and Callback Responses</a></li>
<li class="toctree-l2"><a class="reference internal" href="manage_documents.html#example-how-to-store-a-video-on-localstorage">Example: How to store a video on localStorage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="revision_storages.html">Revision Storages: Conflicts and Resolution</a><ul>
<li class="toctree-l2"><a class="reference internal" href="revision_storages.html#why-conflicts-can-occur">Why Conflicts can Occur</a></li>
<li class="toctree-l2"><a class="reference internal" href="revision_storages.html#how-to-solve-conflicts">How to solve conflicts</a></li>
<li class="toctree-l2"><a class="reference internal" href="revision_storages.html#simple-conflict-example">Simple Conflict Example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="available_storages.html">List of Available Storages</a><ul>
<li class="toctree-l2"><a class="reference internal" href="available_storages.html#connectors">Connectors</a></li>
<li class="toctree-l2"><a class="reference internal" href="available_storages.html#handlers">Handlers</a></li>
<li class="toctree-l2"><a class="reference internal" href="available_storages.html#revision-based-handlers">Revision Based Handlers</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gid_storage.html">JIO GIDStorage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="gid_storage.html#where-it-can-be-used">Where it can be used</a></li>
<li class="toctree-l2"><a class="reference internal" href="gid_storage.html#storage-description">Storage Description</a></li>
<li class="toctree-l2"><a class="reference internal" href="gid_storage.html#document-requirements">Document Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="gid_storage.html#storage-requirements">Storage Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="gid_storage.html#dependencies">Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="gid_storage.html#suggested-storage-tree">Suggested storage tree</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="complex_queries.html">JIO Complex Queries</a><ul>
<li class="toctree-l2"><a class="reference internal" href="complex_queries.html#what-are-complex-queries">What are Complex Queries?</a></li>
<li class="toctree-l2"><a class="reference internal" href="complex_queries.html#why-use-complex-queries">Why use Complex Queries?</a></li>
<li class="toctree-l2"><a class="reference internal" href="complex_queries.html#how-to-use-complex-queries-with-jio">How to use Complex Queries with jIO?</a></li>
<li class="toctree-l2"><a class="reference internal" href="complex_queries.html#how-to-use-complex-queries-outside-jio">How to use Complex Queries outside jIO?</a></li>
<li class="toctree-l2"><a class="reference internal" href="complex_queries.html#json-schemas-and-grammar">JSON Schemas and Grammar</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="metadata.html">Metadata</a><ul>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#what-is-metadata">What is metadata?</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#why-use-metadata">Why use metadata?</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#how-to-format-metadata-with-jio">How to format metadata with JIO</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#list-of-metadata-to-use">List of metadata to use</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#examples">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#tools">Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="metadata.html#sources">Sources</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="developers.html">For developers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="developers.html#quick-start">Quick start</a></li>
<li class="toctree-l2"><a class="reference internal" href="developers.html#naming-conventions">Naming Conventions</a></li>
<li class="toctree-l2"><a class="reference internal" href="developers.html#how-to-design-your-own-jio-storage-library">How to design your own jIO Storage Library</a></li>
<li class="toctree-l2"><a class="reference internal" href="developers.html#job-rules">Job rules</a></li>
<li class="toctree-l2"><a class="reference internal" href="developers.html#create-job-condition">Create Job Condition</a></li>
<li class="toctree-l2"><a class="reference internal" href="developers.html#add-job-rules">Add job rules</a></li>
<li class="toctree-l2"><a class="reference internal" href="developers.html#clear-replace-default-job-rules">Clear/Replace default job rules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="naming_conventions.html">JavaScript Naming Conventions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="naming_conventions.html#essential-conventions">Essential Conventions</a></li>
<li class="toctree-l2"><a class="reference internal" href="naming_conventions.html#coding-conventions">Coding Conventions</a></li>
<li class="toctree-l2"><a class="reference internal" href="naming_conventions.html#id1">Naming Conventions</a></li>
<li class="toctree-l2"><a class="reference internal" href="naming_conventions.html#additional-readings">Additional Readings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Authors</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">Copyright and license</a></li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="#">
<img class="logo" src="_static/jio-logo.png" alt="Logo"/>
</a></p>
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to JIO’s documentation!</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="introduction.html"
title="next chapter">Introduction</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="introduction.html" title="Introduction"
>next</a> |</li>
<li><a href="#">JIO 2.0.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, Nexedi.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>