Merge branch 'master' into erp5storage

Conflicts:
	src/jio.storage/erp5storage.js
	test/jiotests.js
	test/jiotests_withoutrequirejs.html

.gitignore

@@ -4,3 +4,5 @@
 
 #dolphin
 .directory
+
+node_modules/*
\ No newline at end of file

Gruntfile.js

+/*jslint indent: 2, maxlen: 80 */
+/*global module */
+
+module.exports = function (grunt) {
+  "use strict";
+
+  // Project configuration.
+  grunt.initConfig({
+    pkg: grunt.file.readJSON('package.json'),
+    jslint: {
+      grunt: {
+        src: ['Gruntfile.js'],
+        options: {
+          errorsOnly: true
+        }
+      },
+      jio: {
+        src: ['src/jio/**/*.js'],
+        exclude: ['src/jio/intro.js', 'src/jio/outro.js'],
+        options: {
+          errorsOnly: true
+        }
+      },
+      jio_storages: {
+        src: ['src/jio.storage/**/*.js'],
+        options: {
+          errorsOnly: true
+        }
+      },
+      jiodate: {
+        src: ['src/jio.date/jiodate.js']
+      },
+      tests: {
+        src: ['test/**/*.js'],
+        options: {
+          errorsOnly: true
+        }
+      },
+      queries: {
+        src: ['src/queries/core/**/*.js'],
+        exclude: [
+          'src/queries/begin.js',
+          'src/queries/end.js',
+          'src/queries/parser-begin.js',
+          'src/queries/parser-end.js'
+        ],
+        options: {
+          errorsOnly: true
+        }
+      }
+    },
+    concat: {
+      jio: {
+        // duplicate files are ignored
+        src: [
+          'src/jio/intro.js',
+
+          // core
+          'src/jio/core/globals.js',
+          'src/jio/core/util.js',
+          'src/jio/core/**/*.js',
+          'src/jio/features/**/*.js',
+
+          // queries
+          'src/queries/core/globals.js',
+          'src/queries/core/query.js',
+          'src/queries/parser-begin.js',
+          'src/queries/build/parser.js',
+          'src/queries/parser-end.js',
+          'src/queries/core/tools.js',
+          'src/queries/core/**/*.js',
+
+          'src/jio/outro.js'
+        ],
+        dest: 'jio.js'
+      }
+    },
+    uglify: {
+      options: {
+        banner: '/*! <%= pkg.name %> <%= pkg.version %> ' +
+          '<%= grunt.template.today("yyyy-mm-dd") %> */\n'
+      },
+      jio: {
+        src: 'jio.js', // '<%= pkg.name %>.js'
+        dest: 'jio.min.js',
+        options: {
+          sourceMap: "jio.min.map"
+        }
+      },
+      jiodate: {
+        src: 'src/jio.date/jiodate.js',
+        dest: 'jiodate.min.js',
+        options: {
+          sourceMap: "jiodate.min.map"
+        }
+      }
+    },
+    qunit: {
+      // grunt doesn't like requirejs
+      files: ['test/tests.html'],
+      options: {
+        timeout: 30000 // if no test occurs for 30 seconds, then timeout
+      }
+    }
+  });
+
+  grunt.loadNpmTasks('grunt-jslint');
+  grunt.loadNpmTasks('grunt-contrib-concat');
+  grunt.loadNpmTasks('grunt-contrib-uglify');
+  grunt.loadNpmTasks('grunt-contrib-qunit');
+
+  grunt.registerTask('default', ['jslint', 'concat', 'uglify', 'qunit']);
+
+  grunt.registerTask('lint', ['jslint']);
+  grunt.registerTask('build', ['concat', 'uglify']);
+  grunt.registerTask('test', ['jslint', 'qunit']);
+};

Makefile

 # dir
-JIO_DIR     = src/jio
-STORAGE_DIR = src/jio.storage
 QUERIES_DIR = src/queries
 
 # files
 JIO         = jio.js
 JIO_MIN     = jio.min.js
-COMPLEX     = complex_queries.js
-COMPLEX_MIN = complex_queries.min.js
-PARSER_PAR  = $(QUERIES_DIR)/parser.par
-PARSER_OUT  = $(QUERIES_DIR)/parser.js
+JIODATE_MIN = jiodate.min.js
+PARSER_PAR  = $(QUERIES_DIR)/core/parser.par
+PARSER_OUT  = $(QUERIES_DIR)/build/parser.js
+UGLIFY      = ./node_modules/grunt-contrib-uglify/node_modules/uglify-js/bin/uglifyjs
+ZIP_FULL    = jio.zip
+ZIP_MINI    = jio-min.zip
 
-## install npm package system wide -> npm -g install <package>
+# npm install jscc-node
+JSCC_CMD   	= node ./node_modules/jscc-node/jscc.js -t ./node_modules/jscc-node/driver_node.js_
 
-## js/cc using rhino
-#JSCC_CMD    = rhino ~/modules/jscc/jscc.js -t ~/modules/jscc/driver_web.js_
-# sh -c 'cd ; npm install jscc-node'
-JSCC_CMD   	= node ~/node_modules/jscc-node/jscc.js -t ~/node_modules/jscc-node/driver_node.js_
-# sh -c 'cd ; npm install jslint'
-LINT_CMD	= $(shell which jslint || echo node ~/node_modules/jslint/bin/jslint.js) --terse
-# sh -c 'cd ; npm install uglify-js'
-UGLIFY_CMD	= $(shell which uglifyjs || echo node ~/node_modules/uglify-js/bin/uglifyjs)
-# sh -c 'cd ; npm install phantomjs'
-PHANTOM_CMD	= $(shell which phantomjs || echo ~/node_modules/phantomjs/bin/phantomjs)
+auto: compile
 
-auto: compile build lint
-build: concat uglify
-
-# The order is important!
-CONCAT_JIO_NAMES = intro exceptions jio.intro storages/* commands/* jobs/status/* jobs/job announcements/announcement activityUpdater announcements/announcer jobs/jobIdHandler jobs/jobManager jobs/jobRules jio.core jio.outro jioNamespace outro
-CONCAT_STORAGE_NAMES = *
-CONCAT_QUERIES_NAMES = begin parser-begin parser parser-end tool queryfactory query simplequery complexquery end
-LINT_NAMES  = exceptions storages/* commands/* jobs/status/* jobs/* announcements/* activityUpdater jio.core jioNamespace
-
-CONCAT_QUERIES_FILES = $(CONCAT_QUERIES_NAMES:%=$(QUERIES_DIR)/%.js)
-CONCAT_JIO_FILES = $(CONCAT_JIO_NAMES:%=$(JIO_DIR)/%.js)
-LINT_FILES  = $(LINT_NAMES:%=$(JIO_DIR)/%.js) $(CONCAT_STORAGE_NAMES:%=$(STORAGE_DIR)/%.js)
-
-# build parser.js
 compile:
+	mkdir -p $(dir $(PARSER_OUT))
 	$(JSCC_CMD) -o $(PARSER_OUT) $(PARSER_PAR)
 
-# concat source files into jio.js and complex-queries.js
-concat:
-	cat $(CONCAT_JIO_FILES) > "$(JIO)"
-	cat $(CONCAT_QUERIES_FILES) > "$(COMPLEX)"
-
-# uglify into jio.min.js and complex.min.js
-uglify:
-	$(UGLIFY_CMD) "$(JIO)" > "$(JIO_MIN)"
-	$(UGLIFY_CMD) "$(COMPLEX)" > "$(COMPLEX_MIN)"
+TMPDIR := $(shell mktemp -d)
+zip:
+	@echo "Preparing $(ZIP_FULL)"
+	@mkdir $(TMPDIR)/jio
+	@mkdir $(TMPDIR)/jio/storage
+	@cp jio.js                              $(TMPDIR)/jio/
+	@cp jiodate.js                          $(TMPDIR)/jio/
+	@cp jioquery.js                         $(TMPDIR)/jio/
+	@cp src/sha1.amd.js                     $(TMPDIR)/jio/
+	@cp src/sha2.amd.js                     $(TMPDIR)/jio/
+	@cp src/sha256.amd.js                   $(TMPDIR)/jio/
+	@cp lib/rsvp/rsvp-custom.js             $(TMPDIR)/jio/
+	@cp lib/rsvp/rsvp-custom.amd.js         $(TMPDIR)/jio/
+	@cp lib/jquery/jquery.js                $(TMPDIR)/jio/
+	@cp lib/require/require.js              $(TMPDIR)/jio/
+	@cp src/jio.storage/localstorage.js     $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/davstorage.js       $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/erp5storage.js      $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/indexstorage.js     $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/gidstorage.js       $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/replicatestorage.js $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/splitstorage.js     $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/cryptstorage.js     $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/revisionstorage.js  $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/replicaterevisionstorage.js     $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/s3storage.js        $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/splitstorage.js     $(TMPDIR)/jio/storage/
+	@cp src/jio.storage/xwikistorage.js     $(TMPDIR)/jio/storage/
+	@cd $(TMPDIR) && zip -q $(ZIP_FULL) -r jio
+	@mv $(TMPDIR)/$(ZIP_FULL) ./
+	@rm -rf $(TMPDIR)/jio
+	@echo "Preparing $(ZIP_MINI)"
+	@mkdir $(TMPDIR)/jio
+	@mkdir $(TMPDIR)/jio/storage
+	@echo "Minimizing JS..."
+	@cp jio.min.js                                 $(TMPDIR)/jio/
+	@cp jio.min.map                                $(TMPDIR)/jio/
+	@cp jiodate.min.js                             $(TMPDIR)/jio/
+	@cp jiodate.min.map                            $(TMPDIR)/jio/
+	@$(UGLIFY) src/sha1.amd.js                     >$(TMPDIR)/jio/sha1.amd.min.js 2>/dev/null
+	@$(UGLIFY) src/sha2.amd.js                     >$(TMPDIR)/jio/sha2.amd.min.js 2>/dev/null
+	@$(UGLIFY) src/sha256.amd.js                   >$(TMPDIR)/jio/sha256.amd.min.js 2>/dev/null
+	@$(UGLIFY) lib/rsvp/rsvp-custom.js             >$(TMPDIR)/jio/rsvp-custom.min.js 2>/dev/null
+	@$(UGLIFY) lib/rsvp/rsvp-custom.amd.js         >$(TMPDIR)/jio/rsvp-custom.amd.min.js 2>/dev/null
+	@cp lib/jquery/jquery.min.js                   $(TMPDIR)/jio/
+	@$(UGLIFY) lib/require/require.js              >$(TMPDIR)/jio/require.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/localstorage.js     >$(TMPDIR)/jio/storage/localstorage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/davstorage.js       >$(TMPDIR)/jio/storage/davstorage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/erp5storage.js      >$(TMPDIR)/jio/storage/erp5storage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/indexstorage.js     >$(TMPDIR)/jio/storage/indexstorage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/gidstorage.js       >$(TMPDIR)/jio/storage/gidstorage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/replicatestorage.js >$(TMPDIR)/jio/storage/replicatestorage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/splitstorage.js     >$(TMPDIR)/jio/storage/splitstorage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/cryptstorage.js     >$(TMPDIR)/jio/storage/cryptstorage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/revisionstorage.js     >$(TMPDIR)/jio/storage/revisionstorage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/replicaterevisionstorage.js     >$(TMPDIR)/jio/storage/replicaterevisionstorage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/s3storage.js        >$(TMPDIR)/jio/storage/s3storage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/splitstorage.js     >$(TMPDIR)/jio/storage/splitstorage.min.js 2>/dev/null
+	@$(UGLIFY) src/jio.storage/xwikistorage.js     >$(TMPDIR)/jio/storage/xwikistorage.min.js 2>/dev/null
+	@cd $(TMPDIR) && zip -q $(ZIP_MINI) -r jio
+	@mv $(TMPDIR)/$(ZIP_MINI) ./
+	@rm -rf $(TMPDIR)
 
-# lint all files in JIO and STORAGE and QUERIES DIR
-# command: jslint [options] file
-# [options] are defined at the top of the source file:
-# Example:
-# /*jslint indent: 2, maxlen: 80 */
-# /*global hex_sha256: true, jQuery: true */
-lint:
-	$(LINT_CMD) $(LINT_FILES)
 
-phantom:
-	$(PHANTOM_CMD) test/run-qunit.js test/jiotests_withoutrequirejs.html | awk 'BEGIN {print "<!DOCTYPE html><html>"} /^<head>$$/, /^<\/body>$$/ {print} END {print "</html>"}' | sed -e 's,^ *<\(/\|\)script.*>$$,,g' > test/unit_test_result.html
-	grep '^  <title>✔ ' test/unit_test_result.html > /dev/null
 
 .phony: clean
 clean:
@@ -71,6 +92,5 @@ clean:
 realclean:
 	rm -f "$(JIO)"
 	rm -f "$(JIO_MIN)"
-	rm -f "$(COMPLEX)"
-	rm -f "$(COMPLEX_MIN)"
+	rm -f "$(JIODATE_MIN)"
 	rm -f "$(PARSER_OUT)"

docs/.gitignore

+_build/*
+env

docs/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/JIO.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/JIO.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/JIO"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/JIO"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

docs/_static/jiodocs.css

+
+/* override sphinx theme */
+
+.line-block {
+  margin-bottom: 0.4em;
+}
+
+pre {
+  padding-left: 15px;
+  padding-righ: 15px;
+  font-size: 0.8em;
+}
+
+
+
+a.button {
+    -moz-border-radius:6px;
+    -webkit-border-radius:6px;
+    border-radius:6px;
+    display:inline-block;
+    color:#ffffff;
+    font-family:arial;
+    font-size:15px;
+    font-weight:bold;
+    padding:6px 24px;
+    text-decoration:none;
+}
+a.button:hover {
+    color:#ffffff;
+}
+a.button:active {
+    position:relative;
+    top:1px;
+}
+
+a.blue-button {
+    -moz-box-shadow:inset 0px 1px 0px 0px #97c4fe;
+    -webkit-box-shadow:inset 0px 1px 0px 0px #97c4fe;
+    box-shadow:inset 0px 1px 0px 0px #97c4fe;
+    background:-webkit-gradient(linear, left top, left bottom, color-stop(0.05, #3d94f6), color-stop(1, #1e62d0));
+    background:-moz-linear-gradient(top, #3d94f6 5%, #1e62d0 100%);
+    background:-webkit-linear-gradient(top, #3d94f6 5%, #1e62d0 100%);
+    background:-o-linear-gradient(top, #3d94f6 5%, #1e62d0 100%);
+    background:-ms-linear-gradient(top, #3d94f6 5%, #1e62d0 100%);
+    background:linear-gradient(to bottom, #3d94f6 5%, #1e62d0 100%);
+    filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#3d94f6', endColorstr='#1e62d0',GradientType=0);
+    background-color:#3d94f6;
+    border:1px solid #337fed;
+    text-shadow:0px 1px 0px #1570cd;
+}
+a.blue-button:hover {
+    background:-webkit-gradient(linear, left top, left bottom, color-stop(0.05, #1e62d0), color-stop(1, #3d94f6));
+    background:-moz-linear-gradient(top, #1e62d0 5%, #3d94f6 100%);
+    background:-webkit-linear-gradient(top, #1e62d0 5%, #3d94f6 100%);
+    background:-o-linear-gradient(top, #1e62d0 5%, #3d94f6 100%);
+    background:-ms-linear-gradient(top, #1e62d0 5%, #3d94f6 100%);
+    background:linear-gradient(to bottom, #1e62d0 5%, #3d94f6 100%);
+    filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#1e62d0', endColorstr='#3d94f6',GradientType=0);
+    background-color:#1e62d0;
+}
+
+a.green-button {
+    -moz-box-shadow:inset 0px 1px 0px 0px #9acc85;
+    -webkit-box-shadow:inset 0px 1px 0px 0px #9acc85;
+    box-shadow:inset 0px 1px 0px 0px #9acc85;
+    background:-webkit-gradient(linear, left top, left bottom, color-stop(0.05, #74ad5a), color-stop(1, #68a54b));
+    background:-moz-linear-gradient(top, #74ad5a 5%, #68a54b 100%);
+    background:-webkit-linear-gradient(top, #74ad5a 5%, #68a54b 100%);
+    background:-o-linear-gradient(top, #74ad5a 5%, #68a54b 100%);
+    background:-ms-linear-gradient(top, #74ad5a 5%, #68a54b 100%);
+    background:linear-gradient(to bottom, #74ad5a 5%, #68a54b 100%);
+    filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#74ad5a', endColorstr='#68a54b',GradientType=0);
+    background-color:#74ad5a;
+    border:1px solid #3b6e22;
+    text-shadow:0px 1px 0px #92b879;
+}
+a.green-button:hover {
+    background:-webkit-gradient(linear, left top, left bottom, color-stop(0.05, #68a54b), color-stop(1, #74ad5a));
+    background:-moz-linear-gradient(top, #68a54b 5%, #74ad5a 100%);
+    background:-webkit-linear-gradient(top, #68a54b 5%, #74ad5a 100%);
+    background:-o-linear-gradient(top, #68a54b 5%, #74ad5a 100%);
+    background:-ms-linear-gradient(top, #68a54b 5%, #74ad5a 100%);
+    background:linear-gradient(to bottom, #68a54b 5%, #74ad5a 100%);
+    filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#68a54b', endColorstr='#74ad5a',GradientType=0);
+    background-color:#68a54b;
+}

docs/_static/jiodocs.js

+/* jslint undef: true */
+/* global jQuery, document */
+
+jQuery(document).ready(function ($) {
+    $('a:contains(Full download)').addClass('button').addClass('blue-button').addClass('blue');
+    $('a:contains(Minified download)').addClass('button').addClass('green-button').addClass('blue');
+});
+

docs/_templates/layout.html

+{%- extends "basic/layout.html" %}
+{%- block extrahead %}
+  <link rel="stylesheet" type="text/css" href="_static/jiodocs.css">
+  <script type="text/javascript" src="_static/jiodocs.js"></script>
+  {{ super() }}
+  {% if theme_touch_icon %}
+    <link rel="apple-touch-icon" href="{{ pathto('_static/' ~ theme_touch_icon, 1) }}" />
+  {% endif %}
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+{% endblock %}
+{%- block relbar2 %}{% endblock %}
+{%- block footer %}
+    <div class="footer">
+      &copy; Copyright {{ copyright }}.
+    <a href="https://github.com/nexedi/jio" class="github">
+      <img style="position: absolute; top: 0; right: 0; border: 0;"
+           src="https://s3.amazonaws.com/github/ribbons/forkme_right_green_007200.png"
+           alt="Fork me on GitHub">
+    </a>
+{%- endblock %}

docs/_templates/side-downloads.html

+
+<h4><a href="./getting_started.html#download-fork" style="color:#008800">Downloads</a></h4>
+

docs/_templates/side-gettingstarted.html

+
+<h4><a href="./getting_started.html">Getting Started</a></h4>
+

docs/_templates/side-informed.html

+
+<h3>Stay Informed</h3>
+
+You can follow our <a href="http://www.j-io.org/blog">blog</a> to get notified about new releases.
+

docs/_templates/side-support.html

+
+<h3>Support</h3>
+<p>
+  We have a <a href="http://www.j-io.org/forum">forum</a> and an <a href="https://github.com/nexedi/jio/issues">issue tracker</a>
+  on GitHub.
+</p>
+

docs/_templates/side-top.html

+<p>
+  <iframe src="http://ghbtns.com/github-btn.html?user=nexedi&repo=jio&type=watch&count=true&size=large"
+    allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
+</p>
+

docs/_themes/.gitignore

+*.pyc
+*.pyo
+.DS_Store

docs/_themes/LICENSE

+Modifications: 
+
+Copyright (c) 2010 Kenneth Reitz.
+
+
+Original Project: 
+
+Copyright (c) 2010 by Armin Ronacher.
+
+
+Some rights reserved.
+
+Redistribution and use in source and binary forms of the theme, with or
+without modification, are permitted provided that the following conditions
+are met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above
+  copyright notice, this list of conditions and the following
+  disclaimer in the documentation and/or other materials provided
+  with the distribution.
+
+* The names of the contributors may not be used to endorse or
+  promote products derived from this software without specific
+  prior written permission.
+
+We kindly ask you to only use these themes in an unmodified manner just
+for Flask and Flask-related products, not for unrelated projects.  If you
+like the visual style and want to use it for your own projects, please
+consider making some larger changes to the themes (such as changing
+font faces, sizes, colors or margins).
+
+THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

docs/_themes/flask_theme_support.py

+# flasky extensions.  flasky pygments style based on tango style
+from pygments.style import Style
+from pygments.token import Keyword, Name, Comment, String, Error, \
+     Number, Operator, Generic, Whitespace, Punctuation, Other, Literal
+
+
+class FlaskyStyle(Style):
+    background_color = "#f8f8f8"
+    default_style = ""
+
+    styles = {
+        # No corresponding class for the following:
+        #Text:                     "", # class:  ''
+        Whitespace:                "underline #f8f8f8",      # class: 'w'
+        Error:                     "#a40000 border:#ef2929", # class: 'err'
+        Other:                     "#000000",                # class 'x'
+
+        Comment:                   "italic #8f5902", # class: 'c'
+        Comment.Preproc:           "noitalic",       # class: 'cp'
+
+        Keyword:                   "bold #004461",   # class: 'k'
+        Keyword.Constant:          "bold #004461",   # class: 'kc'
+        Keyword.Declaration:       "bold #004461",   # class: 'kd'
+        Keyword.Namespace:         "bold #004461",   # class: 'kn'
+        Keyword.Pseudo:            "bold #004461",   # class: 'kp'
+        Keyword.Reserved:          "bold #004461",   # class: 'kr'
+        Keyword.Type:              "bold #004461",   # class: 'kt'
+
+        Operator:                  "#582800",   # class: 'o'
+        Operator.Word:             "bold #004461",   # class: 'ow' - like keywords
+
+        Punctuation:               "bold #000000",   # class: 'p'
+
+        # because special names such as Name.Class, Name.Function, etc.
+        # are not recognized as such later in the parsing, we choose them
+        # to look the same as ordinary variables.
+        Name:                      "#000000",        # class: 'n'
+        Name.Attribute:            "#c4a000",        # class: 'na' - to be revised
+        Name.Builtin:              "#004461",        # class: 'nb'
+        Name.Builtin.Pseudo:       "#3465a4",        # class: 'bp'
+        Name.Class:                "#000000",        # class: 'nc' - to be revised
+        Name.Constant:             "#000000",        # class: 'no' - to be revised
+        Name.Decorator:            "#888",           # class: 'nd' - to be revised
+        Name.Entity:               "#ce5c00",        # class: 'ni'
+        Name.Exception:            "bold #cc0000",   # class: 'ne'
+        Name.Function:             "#000000",        # class: 'nf'
+        Name.Property:             "#000000",        # class: 'py'
+        Name.Label:                "#f57900",        # class: 'nl'
+        Name.Namespace:            "#000000",        # class: 'nn' - to be revised
+        Name.Other:                "#000000",        # class: 'nx'
+        Name.Tag:                  "bold #004461",   # class: 'nt' - like a keyword
+        Name.Variable:             "#000000",        # class: 'nv' - to be revised
+        Name.Variable.Class:       "#000000",        # class: 'vc' - to be revised
+        Name.Variable.Global:      "#000000",        # class: 'vg' - to be revised
+        Name.Variable.Instance:    "#000000",        # class: 'vi' - to be revised
+
+        Number:                    "#990000",        # class: 'm'
+
+        Literal:                   "#000000",        # class: 'l'
+        Literal.Date:              "#000000",        # class: 'ld'
+
+        String:                    "#4e9a06",        # class: 's'
+        String.Backtick:           "#4e9a06",        # class: 'sb'
+        String.Char:               "#4e9a06",        # class: 'sc'
+        String.Doc:                "italic #8f5902", # class: 'sd' - like a comment
+        String.Double:             "#4e9a06",        # class: 's2'
+        String.Escape:             "#4e9a06",        # class: 'se'
+        String.Heredoc:            "#4e9a06",        # class: 'sh'
+        String.Interpol:           "#4e9a06",        # class: 'si'
+        String.Other:              "#4e9a06",        # class: 'sx'
+        String.Regex:              "#4e9a06",        # class: 'sr'
+        String.Single:             "#4e9a06",        # class: 's1'
+        String.Symbol:             "#4e9a06",        # class: 'ss'
+
+        Generic:                   "#000000",        # class: 'g'
+        Generic.Deleted:           "#a40000",        # class: 'gd'
+        Generic.Emph:              "italic #000000", # class: 'ge'
+        Generic.Error:             "#ef2929",        # class: 'gr'
+        Generic.Heading:           "bold #000080",   # class: 'gh'
+        Generic.Inserted:          "#00A000",        # class: 'gi'
+        Generic.Output:            "#888",           # class: 'go'
+        Generic.Prompt:            "#745334",        # class: 'gp'
+        Generic.Strong:            "bold #000000",   # class: 'gs'
+        Generic.Subheading:        "bold #800080",   # class: 'gu'
+        Generic.Traceback:         "bold #a40000",   # class: 'gt'
+    }

docs/_themes/kr/layout.html

+{%- extends "basic/layout.html" %}
+{%- block extrahead %}
+  {{ super() }}
+  {% if theme_touch_icon %}
+    <link rel="apple-touch-icon" href="{{ pathto('_static/' ~ theme_touch_icon, 1) }}" />
+  {% endif %}
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
+{% endblock %}
+{%- block relbar2 %}{% endblock %}
+{%- block footer %}
+    <div class="footer">
+      &copy; Copyright {{ copyright }}.
+    </div>
+    <a href="https://github.com/nexedi/jio" class="github">
+        <img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" />
+    </a>
+
+<script type="text/javascript">
+  var _gauges = _gauges || [];
+  (function() {
+    var t   = document.createElement('script');
+    t.type  = 'text/javascript';
+    t.async = true;
+    t.id    = 'gauges-tracker';
+    t.setAttribute('data-site-id', '50f10bd6613f5d3e2c00000e');
+    t.src = '//secure.gaug.es/track.js';
+    var s = document.getElementsByTagName('script')[0];
+    s.parentNode.insertBefore(t, s);
+  })();
+</script>
+
+
+
+{%- endblock %}

docs/_themes/kr/relations.html

+<h3>Related Topics</h3>
+<ul>
+  <li><a href="{{ pathto(master_doc) }}">Documentation overview</a><ul>
+  {%- for parent in parents %}
+  <li><a href="{{ parent.link|e }}">{{ parent.title }}</a><ul>
+  {%- endfor %}
+    {%- if prev %}
+      <li>Previous: <a href="{{ prev.link|e }}" title="{{ _('previous chapter')
+        }}">{{ prev.title }}</a></li>
+    {%- endif %}
+    {%- if next %}
+      <li>Next: <a href="{{ next.link|e }}" title="{{ _('next chapter')
+        }}">{{ next.title }}</a></li>
+    {%- endif %}
+  {%- for parent in parents %}
+  </ul></li>
+  {%- endfor %}
+  </ul></li>
+</ul>

docs/_themes/kr/static/flasky.css_t

+/*
+ * flasky.css_t
+ * ~~~~~~~~~~~~
+ *
+ * :copyright: Copyright 2010 by Armin Ronacher. Modifications by Kenneth Reitz.
+ * :license: Flask Design License, see LICENSE for details.
+ */
+
+{% set page_width = '940px' %}
+{% set sidebar_width = '220px' %}
+
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+    font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro';
+    font-size: 17px;
+    background-color: white;
+    color: #000;
+    margin: 0;
+    padding: 0;
+}
+
+div.document {
+    width: {{ page_width }};
+    margin: 30px auto 0 auto;
+}
+
+div.documentwrapper {
+    float: left;
+    width: 100%;
+}
+
+div.bodywrapper {
+    margin: 0 0 0 {{ sidebar_width }};
+}
+
+div.sphinxsidebar {
+    width: {{ sidebar_width }};
+}
+
+hr {
+    border: 1px solid #B1B4B6;
+}
+
+div.body {
+    background-color: #ffffff;
+    color: #3E4349;
+    padding: 0 30px 0 30px;
+}
+
+img.floatingflask {
+    padding: 0 0 10px 10px;
+    float: right;
+}
+
+div.footer {
+    width: {{ page_width }};
+    margin: 20px auto 30px auto;
+    font-size: 14px;
+    color: #888;
+    text-align: right;
+}
+
+div.footer a {
+    color: #888;
+}
+
+div.related {
+    display: none;
+}
+
+div.sphinxsidebar a {
+    color: #444;
+    text-decoration: none;
+    border-bottom: 1px dotted #999;
+}
+
+div.sphinxsidebar a:hover {
+    border-bottom: 1px solid #999;
+}
+
+div.sphinxsidebar {
+    font-size: 14px;
+    line-height: 1.5;
+}
+
+div.sphinxsidebarwrapper {
+    padding: 18px 10px;
+}
+
+div.sphinxsidebarwrapper p.logo {
+    padding: 0;
+    margin: -10px 0 0 -20px;
+    text-align: center;
+}
+div.sphinxsidebarwrapper h1 {
+    font-size: 25px;
+}
+
+div.sphinxsidebar h3,
+div.sphinxsidebar h4 {
+    font-family: 'Garamond', 'Georgia', serif;
+    color: #444;
+    font-size: 24px;
+    font-weight: normal;
+    margin: 0 0 5px 0;
+    padding: 0;
+}
+
+div.sphinxsidebar h4 {
+    font-size: 20px;
+}
+
+div.sphinxsidebar h3 a {
+    color: #444;
+}
+
+div.sphinxsidebar p.logo a,
+div.sphinxsidebar h3 a,
+div.sphinxsidebar p.logo a:hover,
+div.sphinxsidebar h3 a:hover {
+    border: none;
+}
+
+div.sphinxsidebar p {
+    color: #555;
+    margin: 10px 0;
+}
+
+div.sphinxsidebar ul {
+    margin: 10px 0;
+    padding: 0;
+    color: #000;
+}
+
+div.sphinxsidebar input {
+    border: 1px solid #ccc;
+    font-family: 'Georgia', serif;
+    font-size: 1em;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+a {
+    color: #004B6B;
+    text-decoration: underline;
+}
+
+a:hover {
+    color: #6D4100;
+    text-decoration: underline;
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+    font-family: 'Garamond', 'Georgia', serif;
+    font-weight: normal;
+    margin: 30px 0px 10px 0px;
+    padding: 0;
+}
+
+div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
+div.body h2 { font-size: 180%; }
+div.body h3 { font-size: 150%; }
+div.body h4 { font-size: 130%; }
+div.body h5 { font-size: 100%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+    color: #ddd;
+    padding: 0 4px;
+    text-decoration: none;
+}
+
+a.headerlink:hover {
+    color: #444;
+    background: #eaeaea;
+}
+
+div.body p, div.body dd, div.body li {
+    line-height: 1.4em;
+}
+
+div.admonition {
+    background: #fafafa;
+    margin: 20px -30px;
+    padding: 10px 30px;
+    border-top: 1px solid #ccc;
+    border-bottom: 1px solid #ccc;
+}
+
+div.admonition tt.xref, div.admonition a tt {
+    border-bottom: 1px solid #fafafa;
+}
+
+dd div.admonition {
+    margin-left: -60px;
+    padding-left: 60px;
+}
+
+div.admonition p.admonition-title {
+    font-family: 'Garamond', 'Georgia', serif;
+    font-weight: normal;
+    font-size: 24px;
+    margin: 0 0 10px 0;
+    padding: 0;
+    line-height: 1;
+}
+
+div.admonition p.last {
+    margin-bottom: 0;
+}
+
+div.highlight {
+    background-color: white;
+}
+
+dt:target, .highlight {
+    background: #FAF3E8;
+}
+
+div.note {
+    background-color: #eee;
+    border: 1px solid #ccc;
+}
+
+div.seealso {
+    background-color: #ffc;
+    border: 1px solid #ff6;
+}
+
+div.topic {
+    background-color: #eee;
+}
+
+p.admonition-title {
+    display: inline;
+}
+
+p.admonition-title:after {
+    content: ":";
+}
+
+pre, tt {
+    font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+    font-size: 0.9em;
+}
+
+img.screenshot {
+}
+
+tt.descname, tt.descclassname {
+    font-size: 0.95em;
+}
+
+tt.descname {
+    padding-right: 0.08em;
+}
+
+img.screenshot {
+    -moz-box-shadow: 2px 2px 4px #eee;
+    -webkit-box-shadow: 2px 2px 4px #eee;
+    box-shadow: 2px 2px 4px #eee;
+}
+
+table.docutils {
+    border: 1px solid #888;
+    -moz-box-shadow: 2px 2px 4px #eee;
+    -webkit-box-shadow: 2px 2px 4px #eee;
+    box-shadow: 2px 2px 4px #eee;
+}
+
+table.docutils td, table.docutils th {
+    border: 1px solid #888;
+    padding: 0.25em 0.7em;
+}
+
+table.field-list, table.footnote {
+    border: none;
+    -moz-box-shadow: none;
+    -webkit-box-shadow: none;
+    box-shadow: none;
+}
+
+table.footnote {
+    margin: 15px 0;
+    width: 100%;
+    border: 1px solid #eee;
+    background: #fdfdfd;
+    font-size: 0.9em;
+}
+
+table.footnote + table.footnote {
+    margin-top: -15px;
+    border-top: none;
+}
+
+table.field-list th {
+    padding: 0 0.8em 0 0;
+}
+
+table.field-list td {
+    padding: 0;
+}
+
+table.footnote td.label {
+    width: 0px;
+    padding: 0.3em 0 0.3em 0.5em;
+}
+
+table.footnote td {
+    padding: 0.3em 0.5em;
+}
+
+dl {
+    margin: 0;
+    padding: 0;
+}
+
+dl dd {
+    margin-left: 30px;
+}
+
+blockquote {
+    margin: 0 0 0 30px;
+    padding: 0;
+}
+
+ul, ol {
+    margin: 10px 0 10px 30px;
+    padding: 0;
+}
+
+pre {
+    background: #eee;
+    padding: 7px 30px;
+    line-height: 1.3em;
+}
+
+dl pre, blockquote pre, li pre {
+    margin-left: -60px;
+    padding-left: 60px;
+}
+
+dl dl pre {
+    margin-left: -90px;
+    padding-left: 90px;
+}
+
+tt {
+    background-color: #ecf0f3;
+    color: #222;
+    /* padding: 1px 2px; */
+}
+
+tt.xref, a tt {
+    background-color: #FBFBFB;
+    border-bottom: 1px solid white;
+}
+
+a.reference {
+    text-decoration: none;
+    border-bottom: 1px dotted #004B6B;
+}
+
+a.reference:hover {
+    border-bottom: 1px solid #6D4100;
+}
+
+a.footnote-reference {
+    text-decoration: none;
+    font-size: 0.7em;
+    vertical-align: top;
+    border-bottom: 1px dotted #004B6B;
+}
+
+a.footnote-reference:hover {
+    border-bottom: 1px solid #6D4100;
+}
+
+a:hover tt {
+    background: #EEE;
+}
+
+
+@media screen and (max-width: 870px) {
+
+    div.sphinxsidebar {
+        display: none;
+    }
+
+    div.document {
+       width: 100%;
+
+    }
+
+    div.documentwrapper {
+        margin-left: 0;
+        margin-top: 0;
+        margin-right: 0;
+        margin-bottom: 0;
+    }
+
+    div.bodywrapper {
+        margin-top: 0;
+        margin-right: 0;
+        margin-bottom: 0;
+        margin-left: 0;
+    }
+
+    ul {
+        margin-left: 0;
+    }
+
+    .document {
+        width: auto;
+    }
+
+    .footer {
+        width: auto;
+    }
+
+    .bodywrapper {
+        margin: 0;
+    }
+
+    .footer {
+        width: auto;
+    }
+
+    .github {
+        display: none;
+    }
+
+
+
+}
+
+
+
+@media screen and (max-width: 875px) {
+
+    body {
+        margin: 0;
+        padding: 20px 30px;
+    }
+
+    div.documentwrapper {
+        float: none;
+        background: white;
+    }
+
+    div.sphinxsidebar {
+        display: block;
+        float: none;
+        width: 102.5%;
+        margin: 50px -30px -20px -30px;
+        padding: 10px 20px;
+        background: #333;
+        color: white;
+    }
+
+    div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
+    div.sphinxsidebar h3 a {
+        color: white;
+    }
+
+    div.sphinxsidebar a {
+        color: #aaa;
+    }
+
+    div.sphinxsidebar p.logo {
+        display: none;
+    }
+
+    div.document {
+        width: 100%;
+        margin: 0;
+    }
+
+    div.related {
+        display: block;
+        margin: 0;
+        padding: 10px 0 20px 0;
+    }
+
+    div.related ul,
+    div.related ul li {
+        margin: 0;
+        padding: 0;
+    }
+
+    div.footer {
+        display: none;
+    }
+
+    div.bodywrapper {
+        margin: 0;
+    }
+
+    div.body {
+        min-height: 0;
+        padding: 0;
+    }
+
+    .rtd_doc_footer {
+        display: none;
+    }
+
+    .document {
+        width: auto;
+    }
+
+    .footer {
+        width: auto;
+    }
+
+    .footer {
+        width: auto;
+    }
+
+    .github {
+        display: none;
+    }
+}
+
+/* misc. */
+
+.revsys-inline {
+    display: none!important;
+}

docs/_themes/kr/static/small_flask.css

+/*
+ * small_flask.css_t
+ * ~~~~~~~~~~~~~~~~~
+ *
+ * :copyright: Copyright 2010 by Armin Ronacher.
+ * :license: Flask Design License, see LICENSE for details.
+ */
+
+body {
+    margin: 0;
+    padding: 20px 30px;
+}
+
+div.documentwrapper {
+    float: none;
+    background: white;
+}
+
+div.sphinxsidebar {
+    display: block;
+    float: none;
+    width: 102.5%;
+    margin: 50px -30px -20px -30px;
+    padding: 10px 20px;
+    background: #333;
+    color: white;
+}
+
+div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
+div.sphinxsidebar h3 a {
+    color: white;
+}
+
+div.sphinxsidebar a {
+    color: #aaa;
+}
+
+div.sphinxsidebar p.logo {
+    display: none;
+}
+
+div.document {
+    width: 100%;
+    margin: 0;
+}
+
+div.related {
+    display: block;
+    margin: 0;
+    padding: 10px 0 20px 0;
+}
+
+div.related ul,
+div.related ul li {
+    margin: 0;
+    padding: 0;
+}
+
+div.footer {
+    display: none;
+}
+
+div.bodywrapper {
+    margin: 0;
+}
+
+div.body {
+    min-height: 0;
+    padding: 0;
+}

docs/_themes/kr/theme.conf

+[theme]
+inherit = basic
+stylesheet = flasky.css
+pygments_style = flask_theme_support.FlaskyStyle
+
+[options]
+touch_icon = 

docs/_themes/kr_small/layout.html

+{% extends "basic/layout.html" %}
+{% block header %}
+  {{ super() }}
+  {% if pagename == 'index' %}
+  <div class=indexwrapper>
+  {% endif %}
+{% endblock %}
+{% block footer %}
+  {% if pagename == 'index' %}
+  </div>
+  {% endif %}
+{% endblock %}
+{# do not display relbars #}
+{% block relbar1 %}{% endblock %}
+{% block relbar2 %}
+  {% if theme_github_fork %}
+    <a href="http://github.com/{{ theme_github_fork }}"><img style="position: fixed; top: 0; right: 0; border: 0;"
+    src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
+  {% endif %}
+{% endblock %}
+{% block sidebar1 %}{% endblock %}
+{% block sidebar2 %}{% endblock %}

docs/_themes/kr_small/static/flasky.css_t

+/*
+ * flasky.css_t
+ * ~~~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- flasky theme based on nature theme.
+ *
+ * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+ 
+@import url("basic.css");
+ 
+/* -- page layout ----------------------------------------------------------- */
+ 
+body {
+    font-family: 'Georgia', serif;
+    font-size: 17px;
+    color: #000;
+    background: white;
+    margin: 0;
+    padding: 0;
+}
+
+div.documentwrapper {
+    float: left;
+    width: 100%;
+}
+
+div.bodywrapper {
+    margin: 40px auto 0 auto;
+    width: 700px;
+}
+
+hr {
+    border: 1px solid #B1B4B6;
+}
+ 
+div.body {
+    background-color: #ffffff;
+    color: #3E4349;
+    padding: 0 30px 30px 30px;
+}
+
+img.floatingflask {
+    padding: 0 0 10px 10px;
+    float: right;
+}
+ 
+div.footer {
+    text-align: right;
+    color: #888;
+    padding: 10px;
+    font-size: 14px;
+    width: 650px;
+    margin: 0 auto 40px auto;
+}
+ 
+div.footer a {
+    color: #888;
+    text-decoration: underline;
+}
+ 
+div.related {
+    line-height: 32px;
+    color: #888;
+}
+
+div.related ul {
+    padding: 0 0 0 10px;
+}
+ 
+div.related a {
+    color: #444;
+}
+ 
+/* -- body styles ----------------------------------------------------------- */
+ 
+a {
+    color: #004B6B;
+    text-decoration: underline;
+}
+ 
+a:hover {
+    color: #6D4100;
+    text-decoration: underline;
+}
+
+div.body {
+    padding-bottom: 40px; /* saved for footer */
+}
+ 
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+    font-family: 'Garamond', 'Georgia', serif;
+    font-weight: normal;
+    margin: 30px 0px 10px 0px;
+    padding: 0;
+}
+
+{% if theme_index_logo %}
+div.indexwrapper h1 {
+    text-indent: -999999px;
+    background: url({{ theme_index_logo }}) no-repeat center center;
+    height: {{ theme_index_logo_height }};
+}
+{% endif %}
+ 
+div.body h2 { font-size: 180%; }
+div.body h3 { font-size: 150%; }
+div.body h4 { font-size: 130%; }
+div.body h5 { font-size: 100%; }
+div.body h6 { font-size: 100%; }
+ 
+a.headerlink {
+    color: white;
+    padding: 0 4px;
+    text-decoration: none;
+}
+ 
+a.headerlink:hover {
+    color: #444;
+    background: #eaeaea;
+}
+ 
+div.body p, div.body dd, div.body li {
+    line-height: 1.4em;
+}
+
+div.admonition {
+    background: #fafafa;
+    margin: 20px -30px;
+    padding: 10px 30px;
+    border-top: 1px solid #ccc;
+    border-bottom: 1px solid #ccc;
+}
+
+div.admonition p.admonition-title {
+    font-family: 'Garamond', 'Georgia', serif;
+    font-weight: normal;
+    font-size: 24px;
+    margin: 0 0 10px 0;
+    padding: 0;
+    line-height: 1;
+}
+
+div.admonition p.last {
+    margin-bottom: 0;
+}
+
+div.highlight{
+    background-color: white;
+}
+
+dt:target, .highlight {
+    background: #FAF3E8;
+}
+
+div.note {
+    background-color: #eee;
+    border: 1px solid #ccc;
+}
+ 
+div.seealso {
+    background-color: #ffc;
+    border: 1px solid #ff6;
+}
+ 
+div.topic {
+    background-color: #eee;
+}
+ 
+div.warning {
+    background-color: #ffe4e4;
+    border: 1px solid #f66;
+}
+ 
+p.admonition-title {
+    display: inline;
+}
+ 
+p.admonition-title:after {
+    content: ":";
+}
+
+pre, tt {
+    font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+    font-size: 0.85em;
+}
+
+img.screenshot {
+}
+
+tt.descname, tt.descclassname {
+    font-size: 0.95em;
+}
+
+tt.descname {
+    padding-right: 0.08em;
+}
+
+img.screenshot {
+    -moz-box-shadow: 2px 2px 4px #eee;
+    -webkit-box-shadow: 2px 2px 4px #eee;
+    box-shadow: 2px 2px 4px #eee;
+}
+
+table.docutils {
+    border: 1px solid #888;
+    -moz-box-shadow: 2px 2px 4px #eee;
+    -webkit-box-shadow: 2px 2px 4px #eee;
+    box-shadow: 2px 2px 4px #eee;
+}
+
+table.docutils td, table.docutils th {
+    border: 1px solid #888;
+    padding: 0.25em 0.7em;
+}
+
+table.field-list, table.footnote {
+    border: none;
+    -moz-box-shadow: none;
+    -webkit-box-shadow: none;
+    box-shadow: none;
+}
+
+table.footnote {
+    margin: 15px 0;
+    width: 100%;
+    border: 1px solid #eee;
+}
+
+table.field-list th {
+    padding: 0 0.8em 0 0;
+}
+
+table.field-list td {
+    padding: 0;
+}
+
+table.footnote td {
+    padding: 0.5em;
+}
+
+dl {
+    margin: 0;
+    padding: 0;
+}
+
+dl dd {
+    margin-left: 30px;
+}
+ 
+pre {
+    padding: 0;
+    margin: 15px -30px;
+    padding: 8px;
+    line-height: 1.3em;
+    padding: 7px 30px;
+    background: #eee;
+    border-radius: 2px;
+    -moz-border-radius: 2px;
+    -webkit-border-radius: 2px;
+}
+
+dl pre {
+    margin-left: -60px;
+    padding-left: 60px;
+}
+
+tt {
+    background-color: #ecf0f3;
+    color: #222;
+    /* padding: 1px 2px; */
+}
+
+tt.xref, a tt {
+    background-color: #FBFBFB;
+}
+
+a:hover tt {
+    background: #EEE;
+}

docs/_themes/kr_small/theme.conf

+[theme]
+inherit = basic
+stylesheet = flasky.css
+nosidebar = true
+pygments_style = flask_theme_support.FlaskyStyle
+
+[options]
+index_logo = ''
+index_logo_height = 120px
+github_fork = ''

docs/authors.rst

+Authors
+=======
+
+* Francois Billioud
+* Tristan Cavelier
+* Sven Franck
+

docs/available_storages.rst

+
+.. _list-of-available-storages:
+
+List of Available Storages
+==========================
+
+jIO saves his job queue in a workspace which is localStorage by default.
+Provided storage descriptions are also stored, and it can be dangerous to
+store passwords.
+
+The best way to create a storage description is to use the (often) provided
+tool given by the storage library. The returned description is secured to avoid
+cleartext, readable passwords (as opposed to encrypted passwords for instance).
+
+When building storage trees, there is no limit on the number of storages you
+can use. The only thing you have to be aware of is compatibility of simple and
+revision based storages.
+
+
+Connectors
+----------
+
+LocalStorage
+^^^^^^^^^^^^
+
+Three methods are provided:
+
+* ``.createDescription(username, [application_name], [mode='localStorage'])``
+* ``.createLocalDescription(username, [application_name])``
+* ``.createMemoryDescription(username, [application_name])``
+
+All parameters are strings.
+
+Examples:
+
+.. code-block:: javascript
+
+    // to work on browser localStorage
+    var jio = jIO.createJIO(local_storage.createDescription('me'));
+
+    // to work on browser memory
+    var jio = jIO.createJIO(local_storage.createMemoryDescription('me'));
+
+    // or
+    {
+      "type": "local",
+      "username": "me",
+      "application_name": "my app name", // optional
+      "mode": "memory" // optional, "localStorage" by default
+    }
+
+DavStorage
+^^^^^^^^^^
+
+The method ``dav_storage.createDescription()`` generates a DAV storage description for
+*none*, *basic* or *digest* authentication.
+
+NB: digest **is not implemented yet**.
+
+.. code-block:: javascript
+
+  dav_storage.createDescription(url, auth_type,
+                                [realm], [username], [password]);
+
+All parameters are strings.
+
+=============   ========================
+parameter       required?
+=============   ========================
+``url``         yes
+``auth_type``   yes
+``realm``       if auth_type == 'digest'
+``username``    if auth_type != 'none'
+``password``    if auth-type != 'none'
+=============   ========================
+
+If ``auth_type`` is the string ``"none"``, then ``realm``, ``username`` and ``password`` are never used.
+
+Descriptions:
+
+.. code-block:: javascript
+
+  // No authentication
+  {
+    "type": "dav",
+    "url": url
+  }
+
+  // Basic authentication
+  {
+    "type": "dav",
+    "url": "url,
+    "basic_login": btoa(username + ":" + password)
+  }
+
+  // Digest authentication is not implemented
+
+**Be careful**: The generated description never contains a readable password, but
+for basic authentication, the password will just be base64 encoded.
+
+S3Storage
+^^^^^^^^^
+
+Live tests OK!
+
+Here is a basic description for jIO. Documentation comming soon.
+
+.. code-block:: javascript
+
+  {
+    "type": "s3",
+    "AWSIdentifier": "my aws identifier",
+    "password": "my password",
+    "server": "bucket_name"
+  }
+
+XWikiStorage
+^^^^^^^^^^^^
+
+Work is in progress.
+
+Searchable Encryption Storage
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Comes with a specific server with can query encrypted documents.
+
+Work is in progress. Documentation comming soon.
+
+.. code-block:: javascript
+
+  {
+    "type": "searchableencryption",
+    "password": "your password",
+    "url": "http://your/url"
+  }
+
+Handlers
+--------
+
+IndexStorage
+^^^^^^^^^^^^
+
+This handler indexes documents metadata into a database (which is a simple
+document) to increase the speed of ``.allDocs()`` requests. However, it is not able to
+manage the ``include_docs`` option.
+
+The sub storages have to manage ``query`` and ``include_docs`` options.
+
+Here is the description:
+
+.. code-block:: javascript
+
+   {
+     type: 'index',
+     indices: [{
+       // doc id where to store indices
+       id: 'index_title_subject.json',
+       // metadata to index
+       index: ['title', 'subject'],
+       attachment: 'db.json', // default 'body'
+       // additional metadata to add to database, default undefined
+       metadata: {
+         type: 'Dataset',
+         format: 'application/json',
+         title: 'My index database',
+         creator: 'Me'
+       },
+       // default equal to parent sub_storage field
+       sub_storage: <sub storage where to store index>
+     }, {
+       id: 'index_year.json',
+       index: 'year'
+       ...
+     }],
+     sub_storage: <sub storage description>
+   }
+
+
+GIDStorage
+^^^^^^^^^^
+
+:ref:`Full description here <gid-storage>`.
+
+SplitStorage
+^^^^^^^^^^^^
+
+Work is in progress. The interoperability is not enabled yet.
+
+This storage splits metadata and attachment data to *n* parts where *n* is the
+number of sub storages. Each parts are stored on one sub storage only.
+
+.. code-block:: javascript
+
+   {
+     type: 'split',
+     storage_list: [
+       <sub storage description>,
+       ...
+     ]
+   }
+
+Other split modes will be added later.
+
+
+Replicate Storage
+^^^^^^^^^^^^^^^^^
+
+Work is in progress.
+
+.. code-block:: javascript
+
+   {
+     type: 'replicate',
+     storage_list: [
+       <sub storage description>,
+       ...
+     ]
+   }
+
+
+Revision Based Handlers
+-----------------------
+
+A revision based handler is a storage which is able to do some document
+versioning using simple storages listed above.
+
+On jIO command parameter, ``_id`` is still used to identify a document, but
+another id ``_rev`` must be defined to use a specific revision of that document.
+
+On command responses, you will find another field ``rev`` which will represent the
+new revision produced by your action. All the document history is kept unless
+you decide to delete older revisions.
+
+Other fields ``conflicts``, ``revisions`` and ``revs_info`` can be returned if the
+options **conflicts: true**, **revs: true** or **revs_info: true** are set.
+
+Revision Storage
+^^^^^^^^^^^^^^^^
+
+This backend uses its sub storage to manage document and their revision. For
+more information, :ref:`see here <revision-storages-conflicts-and-resolution>`.
+
+Description:
+
+.. code-block:: javascript
+
+  {
+    "type": "revision",
+    "sub_storage": <sub storage description>
+  }
+
+
+Replicate Revision Storage
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Replicate revisions across multiple revision based storages.
+
+Description:
+
+.. code-block:: javascript
+
+  {
+    "type": "revision",
+    "storage_list": [
+      <revision based sub storage description>,
+      ...
+    ]
+  }

docs/conf.py

+# -*- coding: utf-8 -*-
+#
+# jIO documentation build configuration file, created by
+# sphinx-quickstart on Fri Nov 15 11:55:08 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+#highlight_language = 'javascript'
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.todo', 'sphinx.ext.ifconfig'] # , 'sphinxcontrib.jsdemo']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'jIO'
+copyright = u'2013, Nexedi'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '2.0.0-wip'
+# The full version, including alpha/beta/rc tags.
+release = '2.0.0-wip'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'default'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = 'jio-logo.png'
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+    'index':    ['side-top.html', 'side-gettingstarted.html', 'side-downloads.html', 'side-support.html', 'side-informed.html', 'searchbox.html'],
+    '**':       ['side-top.html', 'localtoc.html', 'relations.html', 'searchbox.html']
+}
+
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'jIOdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'jIO.tex', u'jIO Documentation',
+   u'Nexedi', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'jio', u'jIO Documentation',
+     [u'Nexedi'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'jIO', u'jIO Documentation',
+   u'Nexedi', 'jIO', 'A JavaScript library to manage documents across multiple storages.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+sys.path.append(os.path.abspath('_themes'))
+html_theme_path = ['_themes']
+html_theme = 'kr'
+

docs/developers.rst

+For developers
+==============
+
+Quick start
+-----------
+
+The source repository includes ready-to-use files, so in case you do
+not want to build jIO yourself, just use *sha256.amd.js*, *rsvp.js*, *jio.js*
+plus the storages and dependencies you need and you will be good to go.
+
+If you want to modify or build jIO yourself, you need to
+
+* Clone from a repository
+
+  ``$ git clone https://github.com/nexedi/jio.git``
+
+* Install `NodeJS <http://nodejs.org/>`_ (including ``npm``)
+
+* Install the Grunt command line with ``npm``.
+
+  ``# npm -g install grunt-cli``
+
+* Install the dependencies.
+
+  ``$ npm install``
+
+* Compile the JS/CC parser.
+
+  ``$ make`` (until we find out how to compile it with grunt)
+
+* Run build.
+
+  ``$ grunt``
+
+
+Naming Conventions
+------------------
+
+All the code follows this :ref:`JavaScript Style Guide <style-guide>`.
+
+How to design your own jIO Storage Library
+------------------------------------------
+
+Create a constructor:
+
+.. code-block:: javascript
+
+    function MyStorage(storage_description) {
+      this._value = storage_description.value;
+      if (typeof this._value !== 'string') {
+        throw new TypeError("'value' description property " +
+                            "is not a string");
+      }
+    }
+
+Create 10 methods: ``post``, ``put``, ``putAttachment``, ``get``, ``getAttachment``,
+``remove``, ``removeAttachment``, ``allDocs``, ``check`` and ``repair``.
+
+.. code-block:: javascript
+
+    MyStorage.prototype.post = function(command, metadata, option) {
+      var document_id = metadata._id;
+      // [...]
+    };
+
+    MyStorage.prototype.get = function(command, param, option) {
+      var document_id = param._id;
+      // [...]
+    };
+
+    MyStorage.prototype.putAttachment = function(command, param, option) {
+      var document_id = param._id;
+      var attachment_id = param._attachment;
+      var attachment_data = param._blob;
+      // [...]
+    };
+
+    // [...]
+
+
+
+(To help you design your methods, some tools are provided by jIO.util.)
+
+The first parameter command provides some methods to act on the jIO job:
+
+* ``success``, to tell jIO that the job is successfully terminated
+
+  ``command.success(status[Text], [{custom key to add to the response}]);``
+
+* ``resolve``, is equal to success
+
+* ``error``, to tell jIO that the job cannot be done
+
+  ``command.error(status[Text], [reason], [message], [{custom key to add to the response}])``
+
+* ``retry``, to tell jIO 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 jIO to decide whether to retry or not. (same API than error)
+
+
+The second parameter ``metadata`` or ``param`` is the first parameter provided by the jIO user.
+
+The third parameter ``option`` is the option parameter provided by the jIO user.
+
+Methods should return the following objects:
+
+* **post()** --> ``success("created", {"id": new_generated_id})``
+
+* **put()**, **remove()**, **putAttachment()** or **removeAttachment()** --> ``success(204)``
+
+* **get()** --> ``success("ok", {"data": document_metadata})``
+
+* **getAttachment()** -->
+
+  .. code-block:: javascript
+
+    success("ok", {"data": binary_string, "content_type": content_type})
+    // or
+    success("ok", {"data": new Blob([data], {"type": content_type})})
+
+* **allDocs()** --> ``success("ok", {"data": row_object})``
+
+* **check()** -->
+
+  .. code-block:: javascript
+
+    // if metadata provides "_id" -> check document state
+    // if metadata doesn't promides "_id" -> check storage state
+    success("no_content")
+    // or
+    error("conflict", "corrupted", "incoherent document or storage")
+
+* **repair()** -->
+
+  .. code-block:: javascript
+
+    // if metadata provides "_id" -> repair document state
+    // if metadata doesn't promides "_id" -> repair storage state
+    success("no_content")
+    // or
+    error("conflict", "corrupted", "impossible to repair document or storage")
+    // DON'T DESIGN STORAGES IF THERE IS NO WAY
+    // TO REPAIR INCOHERENT STATES
+
+After creating all methods, your storage must be added to jIO. This is done
+with the ``jIO.addStorage()`` method, which requires two parameters: the storage
+type (string) and a constructor (function). It is called like this:
+
+.. code-block:: javascript
+
+    // add custom storage to jIO
+    jIO.addStorage('mystoragetype', MyStorage);
+
+
+Please refer to *localstorage.js* implementation for a good example on how to
+setup a storage and what methods are required.
+
+Also keep in mind that jIO is a job-based library: whenever you trigger a method,
+a job is created, which will later return a response, after being processed.
+
+Job rules
+---------
+
+The jIO job manager follows several rules set at the creation of a new jIO
+instance. When you try to call a method, jIO will create a job and will make
+sure the job is really necessary and will be executed. Thanks to these job
+rules, jIO knows what to do with the new job before adding it to the queue. You
+can also add your own rules, as we're going to see now.
+
+These are the jIO **default rules**:
+
+.. code-block:: javascript
+
+    var jio_instance = jIO.createJIO(storage_description, {
+      "job_rules": [{
+        "code_name": "readers update",
+        "conditions": [
+          "sameStorageDescription",
+          "areReaders",
+          "sameMethod",
+          "sameParameters",
+          "sameOptions"
+        ],
+        "action": "update"
+      }, {
+        "code_name": "metadata writers update",
+        "conditions": [
+          "sameStorageDescription",
+          "areWriters",
+          "useMetadataOnly",
+          "sameMethod",
+          "haveDocumentIds",
+          "sameParameters"
+        ],
+        "action": "update"
+      }, {
+        "code_name": "writers wait",
+        "conditions": [
+          "sameStorageDescription",
+          "areWriters",
+          "haveDocumentIds",
+          "sameDocumentId"
+        ],
+        "action": "wait"
+      }]
+    });
+
+
+The following actions can be used:
+
+* ``ok`` - accept the job
+* ``wait`` - wait until the end of the selected job
+* ``update`` - bind the selected job to this one
+* ``deny`` - reject the job
+
+The following condition functions can be used:
+
+* ``sameStorageDescription`` - check if the storage descriptions are different.
+* ``areWriters`` - check if the commands are ``post``, ``put``, ``putAttachment``, ``remove``, ``removeAttachment``, or ``repair``.
+* ``areReaders`` - check if the commands are ``get``, ``getAttachment``, ``allDocs`` or ``check``.
+* ``useMetadataOnly`` - check if the commands are ``post``, ``put``, ``get``, ``remove`` or ``allDocs``.
+* ``sameMethod`` - check if the commands are equal.
+* ``sameDocumentId`` - check if the document ids are equal.
+* ``sameParameters`` - check if the metadata or param are equal (deep comparison).
+* ``sameOptions`` - check if the command options are equal.
+* ``haveDocumentIds`` - test if the two commands contain document ids.
+
+Create Job Condition
+--------------------
+
+You can create two types of function: job condition, and job comparison.
+
+.. code-block:: javascript
+
+    // Job Condition
+    // Check if the job is a get command
+
+    jIO.addJobRuleCondition("isGetMethod", function (job) {
+      return job.method === 'get';
+    });
+
+
+    // Job Comparison
+    // Check if the jobs have the same 'title' property
+    // only if they are strings
+
+    jIO.addJobRuleCondition("sameTitleIfString",
+        function (job, selected_job) {
+          if (typeof job.kwargs.title === 'string' &&
+              typeof selected_job.kwargs.title === 'string') {
+            return job.kwargs.title === selected_job.kwargs.title;
+          }
+          return false;
+        });
+
+
+Add job rules
+-------------
+
+You just have to define job rules in the jIO options:
+
+.. code-block:: javascript
+
+    // Do not accept to post or put a document which title is equal
+    // to another already running post or put document title
+
+    var jio_instance = jIO.createJIO(storage_description, {
+      "job_rules": [{
+        "code_name": "avoid similar title",
+        "conditions": [
+          "sameStorageDescription",
+          "areWriters",
+          "sameTitleIfString"
+        ],
+        "action": "deny",
+        "before": "writers update" // optional
+        // "after": also exists
+      }]
+    });
+
+
+Clear/Replace default job rules
+-------------------------------
+
+If a job's ``code_name`` is equal to ``readers update``, then adding this rule will replace it:
+
+.. code-block:: javascript
+
+    var jio_instance = jIO.createJIO(storage_description, {
+      "job_rules": [{
+        "code_name": "readers update",
+        "conditions": [
+          "sameStorageDescription",
+          "areReaders",
+          "sameMethod",
+          "haveDocumentIds"
+          "sameParameters"
+          // sameOptions is removed
+        ],
+        "action": "update"
+      }]
+    });
+
+Or you can just clear all rules before adding new ones:
+
+.. code-block:: javascript
+
+    var jio_instance = jIO.createJIO(storage_description, {
+      "clear_job_rules": true,
+      "job_rules": [{
+        // ...
+      }]
+    });

docs/getting_started.rst

+
+Getting started
+===============
+
+#.  :ref:`Download <download-fork>` the core jIO, the storages you need and the
+    dependencies required for them.
+
+#.  Add the scripts to your HTML page in the following order:
+
+    .. code-block:: html
+
+      <!-- jio core + dependencies -->
+      <script src="sha256.amd.js"></script>
+      <script src="rsvp-custom.js"></script>
+      <script src="jio.js"></script>
+
+      <!-- storages + dependencies -->
+      <script src="localstorage.js"></script>
+      <script src="davstorage.js"></script>
+
+      <script ...>
+
+
+    With `RequireJS <http://requirejs.org/>`_, the main.js will look like:
+
+    .. code-block:: javascript
+
+        require.config({
+            paths: {
+                // jio core + dependency
+                sha256: 'sha256.amd',   // AMD-compatible version of sha256.js
+                rsvp: 'rsvp-custom',
+                jio: 'jio',
+                // storages + dependencies
+                localstorage: 'localstorage',
+                davstorage: 'davstorage'
+            }
+        });
+
+
+#.  jIO connects to a number of storages and allows adding handlers (or
+    functions) to specific storages.
+    You can use both handlers and available storages to build a storage
+    tree across which all documents will be maintained and managed by jIO.
+
+    .. code-block:: javascript
+
+        // create your jio instance
+        var my_jio = jIO.createJIO(storage_description);
+
+    You have to provide a ``storage_description`` object, providing location
+    and credentials.
+
+    Its format depends on the type of storage,
+    see :ref:`List of Available Storages <list-of-available-storages>`.
+
+
+#.  The jIO API provides ten main methods to manage documents across the storage(s) specified in your jIO storage tree.
+
+    For details on the ``document`` and ``attachment`` objects, see :ref:`What is a document? <what-is-a-document>`
+
+
+    =======================  ======================================================
+    Method                   Example
+    =======================  ======================================================
+    ``.post()``              |  ``my_jio.post(document, [options]);``
+                             |  Creates a new document
+    ``.put()``               |  ``my_jio.put(document, [options]);``
+                             |  Creates/Updates a document
+    ``.putAttachment()``     |  ``my_jio.putAttachement(attachment, [options]);```
+                             |  Updates/Adds an attachment to a document
+    ``.get()``               |  ``my_jio.get(document, [options]);``
+                             |  Reads a document
+    ``.getAttachment()``     |  ``my_jio.getAttachment(attachment, [options]);``
+                             |  Reads a document attachment
+    ``.remove()``            |  ``my_jio.remove(document, [options]);``
+                             |  Deletes a document and its attachments
+    ``.removeAttachment()``  |  ``my_jio.removeAttachment(attachment, [options]);``
+                             |  Deletes a document's attachment
+    ``.allDocs()``           |  ``my_jio.allDocs([options]);``
+                             |  Retrieves a list of existing documents
+    ``.check()``             |  ``my_jio.check(document, [options]);``
+                             |  Checks the document state
+    ``.repair()``            |  ``my_jio.repair(document, [options]);``
+                             |  Repairs the document
+    =======================  ======================================================
+
+
+
+.. _download-fork:
+
+Download & Fork
+---------------
+
+Please note that the current (2.0.0-wip) version is not stable yet.
+
+You can use one of the ZIP packages, which include all the dependencies and storages:
+
+`Full download (172k) <_static/jio-2.0.0-wip.zip>`_
+`Minified download (87k) <_static/jio-2.0.0-wip-min.zip>`_
+
+or you can create your own set of files, which are are provided in the above packages and the source repository:
+
+
+Core
+^^^^
+
+* sha256.amd.js
+* rsvp-custom.js, AMD only version: rsvp-custom.amd.js
+* jio.js
+
+Storage dependencies
+^^^^^^^^^^^^^^^^^^^^
+
+.. XXX this is a little confusing.
+
+* `jquery.js <http://code.jquery.com/jquery.js>`_
+* `Stanford Javascript Crypto Library <http://bitwiseshiftleft.github.io/sjcl/>`_, `sjcl.zip <https://crypto.stanford.edu/sjcl/sjcl.zip>`_
+* `pajhome.org.uk sha1 <http://pajhome.org.uk/crypt/md5/sha1.html>`_, AMD-compatible version: `sha1.amd.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/sha1.amd.js>`_
+* `anmar.eu.org jssha2 <http://anmar.eu.org/projects/jssha2/>`_, `jssha2.zip <http://anmar.eu.org/projects/jssha2/files/jssha2-0.3.zip>`_, AMD-compatible versions: `sha2.amd.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/sha2.amd.js>`_, `sha256.amd.js <http://git.erp5.org/gitweb/jio.git/blob_plain/refs/heads/master:/src/sha256.amd.js>`_
+
+Storage connectors
+^^^^^^^^^^^^^^^^^^
+
+* localstorage.js
+* davstorage.js
+* searchableencryptionstorage.js (depends on sjcl) (WIP)
+* s3storage.js (depends on sha1, jQuery) (WIP)
+* xwikistorage.js (depends on jQuery) (WIP)
+* erp5storage.js (WIP)
+* restsqlstorage.js (depends on jQuery) (WIP)
+* mioga2storage.js (depends on jQuery) (WIP)
+
+Storage handlers
+^^^^^^^^^^^^^^^^
+
+* indexstorage.js
+* gidstorage.js
+* splitstorage.js (WIP)
+* replicatestorage.js (WIP)
+
+Revision based storage handlers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* revisionstorage.js (depends on sha256)
+* replicaterevisionstorage.js
+
+
+Unit tests
+^^^^^^^^^^
+
+We monitor code quality with a `test agent <http://www.j-io.org/quality/unit_test>`_ that runs
+the test suite with each release.
+
+Fork jIO
+^^^^^^^^
+
+The same source code is kept in three synchronized repositories.
+Feel free to use any of them.
+
+* `GitHub <https://github.com/nexedi/jio>`_: ``git clone https://github.com/nexedi/jio.git``
+* `Gitorius <https://gitorious.org/nexedi/jio>`_: ``git clone https://git.gitorious.org/nexedi/jio.git``
+* `Git Erp5 <http://git.erp5.org/gitweb/jio.git>`_ (read only): ``git clone http://git.erp5.org/repos/jio.git``

docs/index.rst

+
+Welcome to jIO
+==============
+
+jIO 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
+CouchDB, that offers connectors to multiple storages, special handlers to
+enhance functionality (replication, revisions, indexing) and a query module to
+retrieve documents and specific information across storage trees.
+
+How does it work?
+-----------------
+
+jIO is composed of two parts - jIO core and storage libraries. The core
+makes use of storage libraries (connectors) to interact with the associated remote
+storage servers. Some queries can be used on top of the ``.allDocs()`` method to
+query documents based on defined criteria.
+
+jIO uses a job management system, so each method call adds a job into a
+queue. The queue is copied in the browser's local storage (by default), so it
+can be restored in case of browser crash. Jobs are invoked
+asynchronously and ongoing jobs are not able to re-trigger to prevent
+conflicts.
+
+
+Copyright and license
+---------------------
+
+jIO is open source and is licensed under the `LGPL <http://en.wikipedia.org/wiki/GNU_Lesser_General_Public_License>`_ license.
+
+
+
+jIO documentation
+-----------------
+
+.. toctree::
+    :maxdepth: 2
+
+    getting_started
+    manage_documents
+    revision_storages
+    available_storages
+    gid_storage
+    query
+    keys
+    metadata
+    developers
+    style_guide
+    authors

lib/jsSha2/docs/changes.txt

-12/21/2004 - version 0.3
-   - Fixed copyright notice
-   - Included license.txt file
-   - Added readme.txt
-   - Released to the public
-
-04/09/2003 - version 0.2
-    - sha256 rewritten ussing some code and ideas
-      from Paul Johnston's sha1.js
-        - Now is possible to get the hash as a string,
-          base 64 encoded or hex encoded.
-        - It can now calculate the hash from unicode
-          strings.
-        - Hexadecimal hash can be lowercase (default)
-          or uppercase.
-    - Optimized the rest of the code.
-    - Written the test page with the test vectors from
-      nist paper.
-    - Tested on OE 6.0 and OE 6.0SP1.
-
-04/08/2003 - version 0.1
-    - First sha256 implementation. It's a dirty one, but works.
-    - Tested on OE 6.0SP1
\ No newline at end of file

lib/jsSha2/license.txt

-Copyright (c) 2003-2004, Angel Marin
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-
- * Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
- * Neither the name of the <ORGANIZATION> nor the names of its contributors may
-   be used to endorse or promote products derived from this software without
-   specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-OF THE POSSIBILITY OF SUCH DAMAGE.