root / trunk / web / dojo / dojox / storage / README
History | View | Annotate | Download (2.81 KB)
| 1 | 9 | andrej.cim | ------------------------------------------------------------------------------- |
|---|---|---|---|
| 2 | Dojo Storage |
||
| 3 | ------------------------------------------------------------------------------- |
||
| 4 | Version X.XXX (does not have separate versioning -- versioned by release date) |
||
| 5 | Last Release date: March 2008 |
||
| 6 | ------------------------------------------------------------------------------- |
||
| 7 | Project state: |
||
| 8 | experimental |
||
| 9 | ------------------------------------------------------------------------------- |
||
| 10 | Credits |
||
| 11 | Brad Neuberg |
||
| 12 | Alex Russell |
||
| 13 | ------------------------------------------------------------------------------- |
||
| 14 | Project description |
||
| 15 | |||
| 16 | dojox.storage provides a JavaScript abstraction for persistent storage |
||
| 17 | as well as pluggable implementations which typically use native browser extensions |
||
| 18 | (e.g. Flash player, Gears) |
||
| 19 | |||
| 20 | ------------------------------------------------------------------------------- |
||
| 21 | Dependencies: |
||
| 22 | |||
| 23 | FlashStorageProvider requires the Flash player |
||
| 24 | GearsStorageProvider requires the Gears extension |
||
| 25 | The various Air*StorageProviders require Adobe's AIR software |
||
| 26 | |||
| 27 | The open source mtasc compiler (www.mtasc.org) is needed to build the |
||
| 28 | ActionScript into SWF format. The SWF object is maintained within svn, so |
||
| 29 | this step is only necessary if Storage.as is modified. A sample build script |
||
| 30 | is provided (buildFlashStorage.sh) |
||
| 31 | |||
| 32 | ------------------------------------------------------------------------------- |
||
| 33 | Documentation |
||
| 34 | |||
| 35 | See http://manual.dojotoolkit.org/WikiHome/DojoDotBook/Book50 for the |
||
| 36 | authoritative Dojo Storage docs. |
||
| 37 | |||
| 38 | See dojox/storage/demos/helloworld.html for a simple Hello World example |
||
| 39 | you can base your code off of. |
||
| 40 | |||
| 41 | ------------------------------------------------------------------------------- |
||
| 42 | Installation instructions |
||
| 43 | |||
| 44 | If you want to use Dojo Storage in a web browser: |
||
| 45 | |||
| 46 | These installation instructions are to use Dojo Storage in a web browser; at |
||
| 47 | runtime, Dojo Storage will autodetect and use the best available storage |
||
| 48 | option. This includes: |
||
| 49 | |||
| 50 | * Google Gears |
||
| 51 | * HTML 5 Web Browsers (Firefox 2+) |
||
| 52 | * Hidden Flash |
||
| 53 | |||
| 54 | If you are using a release build (if you downloaded Dojo from the Dojo |
||
| 55 | website then this is a release build -- if you checked it out from |
||
| 56 | Subversion yourself then you will have to build things yourself), if you |
||
| 57 | only want to grab just the files from Dojo to use Dojo Storage |
||
| 58 | in the browser, take the following (but make sure to keep the directory |
||
| 59 | layout the same, or else things won't work correctly!): |
||
| 60 | |||
| 61 | * dojo/dojo.js |
||
| 62 | * dojox/storage/storage-browser.js |
||
| 63 | * dojox/storage/Storage.swf |
||
| 64 | |||
| 65 | To help with testing and development and to make sure you have everything |
||
| 66 | right, its also useful to grab the following files: |
||
| 67 | |||
| 68 | * dojox/storage/README |
||
| 69 | * dojox/storage/demos/helloworld.html |
||
| 70 | |||
| 71 | If you want to use Dojo Storage with Adobe AIR: |
||
| 72 | |||
| 73 | [TBD! Why don't you write this and contribute!] |
||
| 74 | |||
| 75 | ------------------------------------------------------------------------------- |
||
| 76 | Additional Notes |