-
Notifications
You must be signed in to change notification settings - Fork 97
/
Copy pathREADME.txt
143 lines (106 loc) · 5.4 KB
/
README.txt
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
Fluid Infusion 0.5
========================
Main Project Site: http://fluidproject.org
User Manual: http://wiki.fluidproject.org/display/fluid/User+Manual+Table+of+Contents
What's New in 0.5
=================
This version of Fluid Infusion includes a number of API changes. The Fluid wiki has instructions
for upgrading your existing 0.4 implementation to use the new 0.5 APIs:
http://wiki.fluidproject.org/display/fluid/Upgrading+to+version+0.5
What's in this Release
======================
This release is available in two forms:
fluid-0.5.zip - deployment bundle
fluid-0.5-src.zip - source code bundle
Both bundles have the following organization:
fluid-components/
sample-code/
tests/
LICENSE.txt
README.txt
The deployment bundle also includes a war file suitable for deployment: fluid-components-0.5.war
Source Code
-----------
The full source code for the Fluid component library, including JavaScript, HTML templates and CSS:
fluid-components/
css/
html/
images/
js/
swfupload/
Both bundles include a single JavaScript file, fluid-components/js/Fluid-all.js, that is a
combination of all other source files. Developers can include this single file in their pages to
provide all the necessary support for the Fluid component Library.
In the deployment bundle, the JavaScript source has been minified: comments and whitespace
have been removed. Developers wishing to learn about the Fluid code, or debug their applications,
should use the source code bundle.
Sample Code
-----------
Sample code illustrating how Fluid components can be used:
sample-code/
inline-edit/
keyboard-a11y/
pager/
reorderer/
uploader/
shared/
Tests
-----
tests/
fluid-tests/
jquery-tests/
jqUnit/
utils/
License
-------
Fluid code is licensed under a dual ECL 2.0 / BSD license. The specific licenses can be found
in the license file:
LICENSE.txt
Fluid also depends upon some third party open source modules. These are contained in their own folders
with their respective licenses inside the fluid source code.
Sources of Intellectual Property Included in Fluid
--------------------------------------------------
This is a list of publicly available software that is included in the Fluid bundle, along with their licensing terms.
* jQuery javascript library: http://jquery.com/ (MIT and GPL licensed http://docs.jquery.com/Licensing)
* jQuery UI javascript widget library: http://ui.jquery.com/ (MIT and GPL licensed http://docs.jquery.com/Licensing)
* QUnit testrunner: http://docs.jquery.com/QUnit (MIT and GPL licensed http://docs.jquery.com/Licensing)
* CSS styling reset from YUI: http://developer.yahoo.com/yui/reset/ (BSD licensed http://developer.yahoo.com/yui/license.html)
* jARIA, the jQuery ARIA plugin: http://jqueryjs.googlecode.com/svn/trunk/plugins/jARIA (MIT and GPL licensed http://docs.jquery.com/Licensing)
* JSON parsing and stringifying methods: http://www.json.org/ (Public Domain)
* SWFUpload: http://swfupload.org/ (MIT licensed http://www.opensource.org/licenses/mit-license.php)
* Real world examples from Sakai (http://sakaiproject.org) and uPortal (http://www.uportal.org/)
Readme
------
This file.
README.txt
Documentation
=============
http://wiki.fluidproject.org/display/fluid/User+Manual+Table+of+Contents
The Fluid Project uses a wiki for documentation and project collaboration: http://wiki.fluidproject.org.
The User Manual for Fluid releases consists of a number of information pages stored in the Fluid Wiki.
The pages fall into a number of categories, including tutorials, API descriptions, testing procedures,
and data-gathering approaches. To make the manual pages easy to locate, identify, and peruse,
we have set up the following aids to navigation:
* An organized table of contents is provided for the reader, with links to
all manual pages, each with a brief description of the page contents.
* A link to the table of contents appears at the top of the left-side wiki navigation
bar with the name User Manual ToC. This makes it easy to return to the table of
contents from anywhere in the wiki hierarchical structure.
Supported Browsers
==================
Firefox 2.x, 3.x: full support
Internet Explorer 6.x, 7.x: full support
Safari 3.1, Opera 9.5: support (except keyboard interaction)
Known Issues
============
The new Pager component is very preliminary: Much of the functionality is not yet implemented.
The Inline Edit component is in development. Some features are present, but more are planned.
The Fluid Project uses a JIRA website to track bugs: http://issues.fluidproject.org.
Some of the known issues in this release are described here:
* Uploader: The Uploader is currently NOT compatible with the Flash 10 beta. This bug is caused by
a change in Adobe's security protocols for Flash 10, which blocks the SWFUpload code from calling
the OS File browser. The SWFUpload community is looking for fixes and work-arounds both in their
own code and in Flash, and we anticipate a work-around or fix before Flash 10 goes final.
* Uploader: After pausing, queue sometimes won't resume
* Reorderer: Nested Reorderers sometimes don't work as expected.
* Keyboard control in the Safari and Opera browsers is not yet fully supported.