aboutsummaryrefslogtreecommitdiff
path: root/includes/js/dojox/storage/README
blob: 28cd2a9b36f9eefd38a65f2ed3669f234e9414a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
-------------------------------------------------------------------------------
Dojo Storage
-------------------------------------------------------------------------------
Version X.XXX (does not have separate versioning -- versioned by release date)
Last Release date: March 2008
-------------------------------------------------------------------------------
Project state:
experimental
-------------------------------------------------------------------------------
Credits
	Brad Neuberg
	Alex Russell
-------------------------------------------------------------------------------
Project description

dojox.storage provides a JavaScript abstraction for persistent storage
as well as pluggable implementations which typically use native browser extensions
(e.g. Flash player, Gears)

-------------------------------------------------------------------------------
Dependencies:

FlashStorageProvider requires the Flash player
GearsStorageProvider requires the Gears extension
The various Air*StorageProviders require Adobe's AIR software

The open source mtasc compiler (www.mtasc.org) is needed to build the
ActionScript into SWF format.  The SWF object is maintained within svn, so
this step is only necessary if Storage.as is modified.  A sample build script
is provided (buildFlashStorage.sh)

-------------------------------------------------------------------------------
Documentation

See http://manual.dojotoolkit.org/WikiHome/DojoDotBook/Book50 for the
authoritative Dojo Storage docs.

See dojox/storage/demos/helloworld.html for a simple Hello World example
you can base your code off of.

-------------------------------------------------------------------------------
Installation instructions

If you want to use Dojo Storage in a web browser:

These installation instructions are to use Dojo Storage in a web browser; at
runtime, Dojo Storage will autodetect and use the best available storage
option. This includes:

  * Google Gears
  * HTML 5 Web Browsers (Firefox 2+)
  * Hidden Flash
  
If you are using a release build (if you downloaded Dojo from the Dojo
website then this is a release build -- if you checked it out from
Subversion yourself then you will have to build things yourself), if you 
only want to grab just the files from Dojo to use Dojo Storage
in the browser, take the following (but make sure to keep the directory
layout the same, or else things won't work correctly!):

* dojo/dojo.js
* dojox/storage/storage-browser.js
* dojox/storage/Storage.swf

To help with testing and development and to make sure you have everything 
right, its also useful to grab the following files:

* dojox/storage/README
* dojox/storage/demos/helloworld.html

If you want to use Dojo Storage with Adobe AIR:

[TBD! Why don't you write this and contribute!]

-------------------------------------------------------------------------------
Additional Notes