source: Dev/branches/rest-dojo-ui/client/dojox/io/README @ 256

Last change on this file since 256 was 256, checked in by hendrikvanantwerpen, 13 years ago

Reworked project structure based on REST interaction and Dojo library. As
soon as this is stable, the old jQueryUI branch can be removed (it's
kept for reference).

File size: 3.2 KB
Line 
1-------------------------------------------------------------------------------
2DojoX IO
3-------------------------------------------------------------------------------
4Version 0.4.0
5Release date: 07/04/2008
6-------------------------------------------------------------------------------
7Project state:
8experimental
9-------------------------------------------------------------------------------
10Credits
11        Bryan Forbes (bryan AT reigndropsfall.net)
12        Kris Zyp (kris AT sitepen.com)
13        James Burke (jburke AT dojotoolkit.org)
14        Tom Trenka (ttrenka AT gmail.com)
15       
16-------------------------------------------------------------------------------
17Project description
18
19        A Collection of advanced and experimental IO modules:
20       
21        * scriptFrame.js - Uses an iframe for dojo.io.script requests. Useful in some
22        long-polling comet situations in Firefox and Opera. Those browsers execute scripts
23        in DOM order, not network-receive order, so a long-polling script will block other
24        dynamically appended scripts from running until it completes. By using an iframe
25        for the dojo.io.script requests, this issue can be avoided.
26
27        * xhrMultiPart.js - Constructs multi-part mime XHR requests. Useful when wanting
28        multi-part requests but not using a form with a file input. Note that it does not
29        allow you to send files from local disks -- a form with a file input is required
30        for that use case. xhrMultipart is not useful in that use case.
31
32        * xhrPlugins.js - An adapter registry for having multiple XHR handlers (like
33        XDomainRequest, CS-XHR, proxy, and window.name)
34
35        * windowName.js - Cross-domain transport using window.name
36        xhrWindowNamePlugin.js - window.name plugin for XHR adapter registry
37
38        * httpParse.js - HTTP message parser. Parses to an XHR like interface.
39       
40        * OAuth.js - Object to be used for signing OpenAuth requests.  Includes easy
41                wrappers for xhr.
42       
43-------------------------------------------------------------------------------
44Dependencies:
45
46DojoX IO xhrMultiPart depends on Dojo Core and DojoX UUID's generateRandomUuid
47function.
48
49xhrWindowNamePlugin depends on dojox.secure.capability for safe JSON parsing
50
51OAuth depends on dojox.encoding.digests.SHA1.
52-------------------------------------------------------------------------------
53Documentation
54
55-------------------------------------------------------------------------------
56Installation instructions
57
58Grab the following from the Dojo SVN Repository:
59http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/uuid.js
60http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/uuid/*
61http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/secure/*
62http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/encoding/digests/*
63
64Install into the following directory structure:
65/dojox/uuid/
66/dojox/secure/
67/dojox/encoding/digests/
68
69AND
70
71Grab the following from the Dojo SVN Repository:
72http://svn.dojotoolkit.org/var/src/dojo/dojox/trunk/io/*
73
74Install into the following directory structure:
75/dojox/io/
76
77...both of which should be at the same level as your Dojo checkout.
78-------------------------------------------------------------------------------
79Additional Notes
80
81The information contained in this README does not pertain to DojoX XHR IFrame Proxy. 
82For that information see proxy/README.
Note: See TracBrowser for help on using the repository browser.