Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
jio
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Hamza
jio
Commits
1c422fd3
Commit
1c422fd3
authored
Nov 18, 2013
by
Marco Mariani
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: consistently use lowercase j in jIO
parent
2f930bbe
Changes
10
Show whitespace changes
Inline
Side-by-side
Showing
10 changed files
with
45 additions
and
50 deletions
+45
-50
docs/sphinx/source/available_storages.rst
docs/sphinx/source/available_storages.rst
+2
-2
docs/sphinx/source/complex_queries.rst
docs/sphinx/source/complex_queries.rst
+1
-1
docs/sphinx/source/conf.py
docs/sphinx/source/conf.py
+7
-7
docs/sphinx/source/developers.rst
docs/sphinx/source/developers.rst
+7
-7
docs/sphinx/source/gid_storage.rst
docs/sphinx/source/gid_storage.rst
+1
-1
docs/sphinx/source/index.rst
docs/sphinx/source/index.rst
+2
-8
docs/sphinx/source/introduction.rst
docs/sphinx/source/introduction.rst
+3
-3
docs/sphinx/source/manage_documents.rst
docs/sphinx/source/manage_documents.rst
+7
-7
docs/sphinx/source/metadata.rst
docs/sphinx/source/metadata.rst
+14
-13
docs/sphinx/source/revision_storages.rst
docs/sphinx/source/revision_storages.rst
+1
-1
No files found.
docs/sphinx/source/available_storages.rst
View file @
1c422fd3
...
@@ -9,7 +9,7 @@
...
@@ -9,7 +9,7 @@
List of Available Storages
List of Available Storages
==========================
==========================
J
IO saves his job queue in a workspace which is localStorage by default.
j
IO saves his job queue in a workspace which is localStorage by default.
Provided storage descriptions are also stored, and it can be dangerous to
Provided storage descriptions are also stored, and it can be dangerous to
store passwords.
store passwords.
...
@@ -144,7 +144,7 @@ Revision Based Handlers
...
@@ -144,7 +144,7 @@ Revision Based Handlers
A revision based handler is a storage which is able to do some document
A revision based handler is a storage which is able to do some document
versioning using simple storages listed above.
versioning using simple storages listed above.
On
J
IO command parameter, ``_id`` is still used to identify a document, but
On
j
IO command parameter, ``_id`` is still used to identify a document, but
another id ``_rev`` must be defined to use a specific revision of this document.
another id ``_rev`` must be defined to use a specific revision of this document.
On command responses, you will find another field ``rev`` which will represent the
On command responses, you will find another field ``rev`` which will represent the
...
...
docs/sphinx/source/complex_queries.rst
View file @
1c422fd3
J
IO Complex Queries
j
IO Complex Queries
===================
===================
What are Complex Queries?
What are Complex Queries?
...
...
docs/sphinx/source/conf.py
View file @
1c422fd3
# -*- coding: utf-8 -*-
# -*- coding: utf-8 -*-
#
#
#
J
IO documentation build configuration file, created by
#
j
IO documentation build configuration file, created by
# sphinx-quickstart on Fri Nov 15 11:55:08 2013.
# sphinx-quickstart on Fri Nov 15 11:55:08 2013.
#
#
# This file is execfile()d with the current directory set to its containing dir.
# This file is execfile()d with the current directory set to its containing dir.
...
@@ -42,7 +42,7 @@ source_suffix = '.rst'
...
@@ -42,7 +42,7 @@ source_suffix = '.rst'
master_doc
=
'index'
master_doc
=
'index'
# General information about the project.
# General information about the project.
project
=
u'
J
IO'
project
=
u'
j
IO'
copyright
=
u'2013, Nexedi'
copyright
=
u'2013, Nexedi'
# The version info for the project you're documenting, acts as replacement for
# The version info for the project you're documenting, acts as replacement for
...
@@ -167,7 +167,7 @@ html_static_path = ['_static']
...
@@ -167,7 +167,7 @@ html_static_path = ['_static']
#html_file_suffix = None
#html_file_suffix = None
# Output file base name for HTML help builder.
# Output file base name for HTML help builder.
htmlhelp_basename
=
'
J
IOdoc'
htmlhelp_basename
=
'
j
IOdoc'
# -- Options for LaTeX output --------------------------------------------------
# -- Options for LaTeX output --------------------------------------------------
...
@@ -186,7 +186,7 @@ latex_elements = {
...
@@ -186,7 +186,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents
=
[
latex_documents
=
[
(
'index'
,
'
JIO.tex'
,
u'J
IO Documentation'
,
(
'index'
,
'
jIO.tex'
,
u'j
IO Documentation'
,
u'Nexedi'
,
'manual'
),
u'Nexedi'
,
'manual'
),
]
]
...
@@ -216,7 +216,7 @@ latex_documents = [
...
@@ -216,7 +216,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
# (source start file, name, description, authors, manual section).
man_pages
=
[
man_pages
=
[
(
'index'
,
'jio'
,
u'
J
IO Documentation'
,
(
'index'
,
'jio'
,
u'
j
IO Documentation'
,
[
u'Nexedi'
],
1
)
[
u'Nexedi'
],
1
)
]
]
...
@@ -230,8 +230,8 @@ man_pages = [
...
@@ -230,8 +230,8 @@ man_pages = [
# (source start file, target name, title, author,
# (source start file, target name, title, author,
# dir menu entry, description, category)
# dir menu entry, description, category)
texinfo_documents
=
[
texinfo_documents
=
[
(
'index'
,
'
JIO'
,
u'J
IO Documentation'
,
(
'index'
,
'
jIO'
,
u'j
IO Documentation'
,
u'Nexedi'
,
'
J
IO'
,
'One line description of project.'
,
u'Nexedi'
,
'
j
IO'
,
'One line description of project.'
,
'Miscellaneous'
),
'Miscellaneous'
),
]
]
...
...
docs/sphinx/source/developers.rst
View file @
1c422fd3
...
@@ -76,26 +76,26 @@ Create 10 methods: ``post``, ``put``, ``putAttachment``, ``get``, ``getAttachmen
...
@@ -76,26 +76,26 @@ Create 10 methods: ``post``, ``put``, ``putAttachment``, ``get``, ``getAttachmen
(To help you design your methods, some tools are provided by jIO.util.)
(To help you design your methods, some tools are provided by jIO.util.)
The first parameter command provides some methods to act on the
J
IO job:
The first parameter command provides some methods to act on the
j
IO job:
* ``success``, to tell
J
IO that the job is successfully terminated
* ``success``, to tell
j
IO that the job is successfully terminated
``command.success(status[Text], [{custom key to add to the response}]);``
``command.success(status[Text], [{custom key to add to the response}]);``
* ``resolve``, is equal to success
* ``resolve``, is equal to success
* ``error``, to tell
J
IO that the job cannot be done
* ``error``, to tell
j
IO that the job cannot be done
``command.error(status[Text], [reason], [message], [{custom key to add to the response}])``
``command.error(status[Text], [reason], [message], [{custom key to add to the response}])``
* ``retry``, to tell
J
IO that the job cannot be done now, but can be retried later. (same API than error)
* ``retry``, to tell
j
IO that the job cannot be done now, but can be retried later. (same API than error)
* ``reject``, to tell
JIO that the job cannot be done, let J
IO to decide whether to retry or not. (same API than error)
* ``reject``, to tell
jIO that the job cannot be done, let j
IO to decide whether to retry or not. (same API than error)
The second parameter ``metadata`` or ``param`` is the first parameter provided by the
J
IO user.
The second parameter ``metadata`` or ``param`` is the first parameter provided by the
j
IO user.
The third parameter ``option`` is the option parameter provided by the
J
IO user.
The third parameter ``option`` is the option parameter provided by the
j
IO user.
Methods should return the following objects:
Methods should return the following objects:
...
...
docs/sphinx/source/gid_storage.rst
View file @
1c422fd3
.. _gid-storage:
.. _gid-storage:
J
IO GIDStorage
j
IO GIDStorage
==============
==============
A storage to enable interoperability between all kind of storages.
A storage to enable interoperability between all kind of storages.
...
...
docs/sphinx/source/index.rst
View file @
1c422fd3
..
J
IO documentation master file, created by
..
j
IO documentation master file, created by
sphinx-quickstart on Fri Nov 15 11:55:08 2013.
sphinx-quickstart on Fri Nov 15 11:55:08 2013.
You can adapt this file completely to your liking, but it should at least
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
contain the root `toctree` directive.
Welcome to
J
IO's documentation!
Welcome to
j
IO's documentation!
===============================
===============================
Contents:
Contents:
...
@@ -24,11 +24,5 @@ Contents:
...
@@ -24,11 +24,5 @@ Contents:
authors
authors
license
license
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`search`
docs/sphinx/source/introduction.rst
View file @
1c422fd3
...
@@ -8,7 +8,7 @@ Introduction
...
@@ -8,7 +8,7 @@ Introduction
What is jIO?
What is jIO?
------------
------------
J
IO is a JavaScript library that allows to manage JSON documents on local or
j
IO is a JavaScript library that allows to manage JSON documents on local or
remote storages in asynchronous fashion. jIO is an abstracted API mapped after
remote storages in asynchronous fashion. jIO is an abstracted API mapped after
CouchDB, that offers connectors to multiple storages, special handlers to
CouchDB, that offers connectors to multiple storages, special handlers to
enhance functionality (replication, revisions, indexing) and a query module to
enhance functionality (replication, revisions, indexing) and a query module to
...
@@ -19,12 +19,12 @@ How does it work?
...
@@ -19,12 +19,12 @@ How does it work?
.. XXX three parts?
.. XXX three parts?
J
IO is separated into three parts - jIO core and storage library(ies). The core
j
IO is separated into three parts - jIO core and storage library(ies). The core
is using storage libraries (connectors) to interact with the associated remote
is using storage libraries (connectors) to interact with the associated remote
storage servers. Some queries can be used on top of the jIO allDocs method to
storage servers. Some queries can be used on top of the jIO allDocs method to
query documents based on defined criteria.
query documents based on defined criteria.
J
IO uses a job management system, so every method called adds a job into a
j
IO uses a job management system, so every method called adds a job into a
queue. The queue is copied in the browser's local storage (by default), so it
queue. The queue is copied in the browser's local storage (by default), so it
can be restored in case of a browser crash. Jobs are being invoked
can be restored in case of a browser crash. Jobs are being invoked
asynchronously with ongoing jobs not being able to re-trigger to prevent
asynchronously with ongoing jobs not being able to re-trigger to prevent
...
...
docs/sphinx/source/manage_documents.rst
View file @
1c422fd3
How to manage documents?
How to manage documents?
========================
========================
J
IO is mapped after the CouchDB API and extends them to provide unified, scalable
j
IO is mapped after the CouchDB API and extends them to provide unified, scalable
and high performance access via Javascript to a wide variety of different
and high performance access via Javascript to a wide variety of different
storage backends.
storage backends.
...
@@ -121,10 +121,10 @@ see how method calls should be made with either of these storages.
...
@@ -121,10 +121,10 @@ see how method calls should be made with either of these storages.
Promises
Promises
--------
--------
Each
J
IO methods returns a Promise object, which allows us to get responses into
Each
j
IO methods returns a Promise object, which allows us to get responses into
callback parameters and to chain callbacks with other returned values.
callback parameters and to chain callbacks with other returned values.
J
IO uses a custom version of `RSVP.js <https://github.com/tildeio/rsvp.js>`_, adding canceler and progression features.
j
IO uses a custom version of `RSVP.js <https://github.com/tildeio/rsvp.js>`_, adding canceler and progression features.
You can read more about promises:
You can read more about promises:
...
@@ -136,7 +136,7 @@ You can read more about promises:
...
@@ -136,7 +136,7 @@ You can read more about promises:
Method Options and Callback Responses
Method Options and Callback Responses
-------------------------------------
-------------------------------------
To retrieve
J
IO responses, you have to provide callbacks like this:
To retrieve
j
IO responses, you have to provide callbacks like this:
.. code-block:: javascript
.. code-block:: javascript
...
@@ -144,11 +144,11 @@ To retrieve JIO responses, you have to provide callbacks like this:
...
@@ -144,11 +144,11 @@ To retrieve JIO responses, you have to provide callbacks like this:
then([responseCallback], [errorCallback], [progressionCallback]);
then([responseCallback], [errorCallback], [progressionCallback]);
* On command success, responseCallback will be called with the
J
IO response as first parameter.
* On command success, responseCallback will be called with the
j
IO response as first parameter.
* On command error, errorCallback will be called with the
J
IO error as first parameter.
* On command error, errorCallback will be called with the
j
IO error as first parameter.
* On command notification, progressionCallback will be called with the storage notification.
* On command notification, progressionCallback will be called with the storage notification.
Here is a list of responses returned by
J
IO according to methods and options:
Here is a list of responses returned by
j
IO according to methods and options:
================== =============================== ======================================
================== =============================== ======================================
...
...
docs/sphinx/source/metadata.rst
View file @
1c422fd3
...
@@ -3,6 +3,7 @@
...
@@ -3,6 +3,7 @@
:language: javascript
:language: javascript
.. _metadata-head:
.. _metadata-head:
Metadata
Metadata
========
========
...
@@ -27,7 +28,7 @@ way to save documents and to get them). So we must use metadata for
...
@@ -27,7 +28,7 @@ way to save documents and to get them). So we must use metadata for
*interoperability reasons*. Interoperability is the ability of diverse systems
*interoperability reasons*. Interoperability is the ability of diverse systems
and organizations to work together.
and organizations to work together.
How to format metadata with
J
IO
How to format metadata with
j
IO
-------------------------------
-------------------------------
See below XML and its JSON equivalent:
See below XML and its JSON equivalent:
...
@@ -60,7 +61,7 @@ List of metadata to use
...
@@ -60,7 +61,7 @@ List of metadata to use
Identification
Identification
^^^^^^^^^^^^^^
^^^^^^^^^^^^^^
* **"_id"**, a specific
J
IO metadata which helps the storage to find a document
* **"_id"**, a specific
j
IO metadata which helps the storage to find a document
(can be a real path name, a dc:identifier, a uuid, ...). **String Only**
(can be a real path name, a dc:identifier, a uuid, ...). **String Only**
* **"identifer"**, :js:`{"identifier": "http://domain/jio_home_page"}, {"identifier": "urn:ISBN:978-1-2345-6789-X"},
* **"identifer"**, :js:`{"identifier": "http://domain/jio_home_page"}, {"identifier": "urn:ISBN:978-1-2345-6789-X"},
...
@@ -131,18 +132,18 @@ Intellectual property
...
@@ -131,18 +132,18 @@ Intellectual property
Content
Content
^^^^^^^
^^^^^^^
* **"title"**, :js:`{"title": "
J
IO Home Page"}`
* **"title"**, :js:`{"title": "
j
IO Home Page"}`
the name given to the resource. Typically, a Title will be a name by which the resource is formally known.
the name given to the resource. Typically, a Title will be a name by which the resource is formally known.
* **"subject"**, :js:`{"subject": "
JIO"}, {"subject": ["J
IO", "basics"]}`
* **"subject"**, :js:`{"subject": "
jIO"}, {"subject": ["j
IO", "basics"]}`
the topic of the content of the resource. Typically, a Subject will be
the topic of the content of the resource. Typically, a Subject will be
expressed as keywords or key phrases or classification codes that describe the
expressed as keywords or key phrases or classification codes that describe the
topic of the resource. Recommended best practice is to select a value from a
topic of the resource. Recommended best practice is to select a value from a
controlled vocabulary or formal classification scheme.
controlled vocabulary or formal classification scheme.
* **"description"**, :js:`{"description": "Simple guide to show the basics of
J
IO"}, {"description": {"lang": "fr", "content": "Ma description"}}`
* **"description"**, :js:`{"description": "Simple guide to show the basics of
j
IO"}, {"description": {"lang": "fr", "content": "Ma description"}}`
an account of the content of the resource. Description may include but is not
an account of the content of the resource. Description may include but is not
limited to: an abstract, table of contents, reference to a graphical
limited to: an abstract, table of contents, reference to a graphical
...
@@ -199,7 +200,7 @@ Content
...
@@ -199,7 +200,7 @@ Content
Examples
Examples
--------
--------
Posting a webpage for
J
IO
Posting a webpage for
j
IO
^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: javascript
.. code-block:: javascript
...
@@ -211,16 +212,16 @@ Posting a webpage for JIO
...
@@ -211,16 +212,16 @@ Posting a webpage for JIO
"date" : new Date(),
"date" : new Date(),
"type" : "Text",
"type" : "Text",
"creator" : ["Nexedi", "Tristan Cavelier", "Sven Franck"],
"creator" : ["Nexedi", "Tristan Cavelier", "Sven Franck"],
"title" : "
J
IO Home Page",
"title" : "
j
IO Home Page",
"subject" : ["
J
IO", "basics"],
"subject" : ["
j
IO", "basics"],
"description" : "Simple guide to show the basics of
J
IO",
"description" : "Simple guide to show the basics of
j
IO",
"category" : ["resilience/jio", "webpage"],
"category" : ["resilience/jio", "webpage"],
"language" : "en"
"language" : "en"
}, callbacks); // send content as attachment
}, callbacks); // send content as attachment
Posting
J
IO library
Posting
j
IO library
^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^
.. code-block:: javascript
.. code-block:: javascript
...
@@ -236,7 +237,7 @@ Posting JIO library
...
@@ -236,7 +237,7 @@ Posting JIO library
"rights" :
"rights" :
"https://www.j-io.org/documentation/jio-documentation/#copyright-and-license",
"https://www.j-io.org/documentation/jio-documentation/#copyright-and-license",
"title" : "Javascript Input/Output",
"title" : "Javascript Input/Output",
"subject" : "
J
IO",
"subject" : "
j
IO",
"category" : ["resilience/javascript", "javascript/library/io"]
"category" : ["resilience/javascript", "javascript/library/io"]
"description" : "jIO is a client-side JavaScript library to manage " +
"description" : "jIO is a client-side JavaScript library to manage " +
"documents across multiple storages."
"documents across multiple storages."
...
@@ -355,14 +356,14 @@ With complex query:
...
@@ -355,14 +356,14 @@ With complex query:
jio.allDocs({"query": "creator: \"someone\""}, callbacks);
jio.allDocs({"query": "creator: \"someone\""}, callbacks);
Getting all documents about
J
IO in the resilience project
Getting all documents about
j
IO in the resilience project
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
With complex query:
With complex query:
.. code-block:: javascript
.. code-block:: javascript
jio.allDocs({"query": "subject: \"
J
IO\" AND category: \"resilience\""}, callbacks);
jio.allDocs({"query": "subject: \"
j
IO\" AND category: \"resilience\""}, callbacks);
...
...
docs/sphinx/source/revision_storages.rst
View file @
1c422fd3
...
@@ -7,7 +7,7 @@ Why Conflicts can Occur
...
@@ -7,7 +7,7 @@ Why Conflicts can Occur
Using jIO you can store documents in multiple storage locations. With
Using jIO you can store documents in multiple storage locations. With
increasing number of users working on a document and some storages not being
increasing number of users working on a document and some storages not being
available or responding too slow, conflicts are more likely to occur.
J
IO
available or responding too slow, conflicts are more likely to occur.
j
IO
defines a conflict as multiple versions of a document existing in a storage
defines a conflict as multiple versions of a document existing in a storage
tree and a user trying to save on a version that does not match the latest
tree and a user trying to save on a version that does not match the latest
version of the document.
version of the document.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment