jscripts/infusion/README.txt

   1 Fluid Infusion 1.1
   2 ==================
   3 Main Project Site:  http://fluidproject.org
   4 Documentation:      http://wiki.fluidproject.org/display/fluid/Infusion+Documentation
   5
   6 What's New in 1.1
   7 =================
   8
   9 This release:
  10
  11     * Updates our supported browsers to include the latest from Yahoo's A-grade browser list
  12       * see http://wiki.fluidproject.org/display/fluid/Browser+Support
  13     * Provides the ability to create custom builds:
  14       * see http://wiki.fluidproject.org/display/fluid/Custom+Build
  15     * Adds jQuery UI Themes for working with FSS themes
  16     * Adds new and powerful decorators for the Renderer:
  17       * The "fluid" decorator instantiates any Fluid Infusion component bound to the markup
  18       * New support for removing arbitrary attributes and CSS classes
  19     * Updates the Pager:
  20       * Improved handing of column sorting
  21       * Fixed persistence of focus
  22     * Updates the Uploader:
  23       * User can manually switch to the standard non-Flash http file uploader
  24       * Uploader Browse button now respects DOM z-index in Flash 10
  25     * Updates the User Interface Options:
  26       * Better cross browser support
  27       * Better keyboard and screen reader accessibility
  28     * Changes some class names in the FSS and components:
  29           * see http://wiki.fluidproject.org/display/fluid/Upgrading+to+Infusion+1.1
  30         * Changes some Framework API:
  31           * see http://wiki.fluidproject.org/display/fluid/Upgrading+to+Infusion+1.1
  32     * Fixes many bugs
  33
  34 What's in this Release
  35 ======================
  36
  37 This release is available in two forms:
  38     Deployment Bundle - infusion-1.1.zip
  39     Source Code Bundle - infusion-1.1-src.zip
  40
  41 In addition to source code, samples and tests, both bundles include at the top level a single JavaScript file
  42
  43     InfusionAll.js
  44
  45 that is a combination of all other source files. Developers can include this single file in their
  46 pages to provide all the necessary support for the Infusion component Library. In the Deployment Bundle,
  47 this script is compressed and suitable for production use.
  48
  49 The Deployment Bundle also includes a WAR file suitable for deployment in Java-based containers:
  50         fluid-components-1.1.war
  51
  52 Source Code
  53 -----------
  54 The organization of the full source code for the Infusion library is as follows:
  55
  56         components/
  57              inlineEdit/
  58              pager/
  59              progress/
  60              reorderer/
  61              tableOfContents/
  62              uiOptions/
  63              undo/
  64              uploader/
  65         framework/
  66              core/
  67              fss/
  68              renderer/
  69         lib/
  70              fastXmlPull/
  71              jquery/
  72              json/
  73              swfobject/
  74              swfupload/
  75
  76 In the Deployment Bundle, the JavaScript source has been minified: comments and whitespace have
  77 been removed.
  78
  79 Developers wishing to learn about the Fluid Infusion code, or debug their applications, should use
  80 the Source Code Bundle.
  81
  82 Examples and Sample Code
  83 ------------------------
  84 Sample code illustrating how Infusion components can be used:
  85
  86         integration-demos/
  87              bspace/    (showcases: Inline Edit)
  88              sakai/     (showcases: Inline Edit, Pager, UI Options, FSS)
  89              uportal/   (showcases: Reorderer, UI Options, FSS)
  90         standalone-demos/
  91              keyboard-a11y/
  92              lib/
  93              pager/
  94              progress/
  95              quick-start-examples/
  96                   fss/
  97                   inlineEdit/
  98                   reorderer/
  99              renderer/
 100              reorderer/
 101              table-of-contents/
 102
 103 Tests
 104 -----
 105         tests/
 106             component-tests/
 107             escalated-tests/
 108             framework-tests/
 109             lib/
 110             manual-tests/
 111             test-core/
 112
 113 License
 114 -------
 115 Fluid Infusion code is licensed under a dual ECL 2.0 / BSD license. The specific licenses can be
 116 found in the license file:
 117         licenses/Infusion-LICENSE.txt
 118
 119 Infusion also depends upon some third party open source modules. These are contained in their own
 120 folders, and their licenses are also present in
 121         licenses/
 122
 123 Third Party Software in Infusion
 124 --------------------------------
 125 This is a list of publicly available software that is included in the Fluid Infusion bundle, along
 126 with their licensing terms.
 127
 128     * jQuery javascript library v1.3.2: http://jquery.com/ (MIT and GPL licensed http://docs.jquery.com/Licensing)
 129     * jQuery UI javascript widget library v1.7: http://ui.jquery.com/ (MIT and GPL licensed http://docs.jquery.com/Licensing)
 130     * jQuery QUnit testrunner r6173: http://docs.jquery.com/QUnit (MIT and GPL licensed http://docs.jquery.com/Licensing)
 131     * Douglas Crockford's JSON parsing and stringifying methods (from 2007-11-06): http://www.json.org/ (Public Domain)
 132     * SWFUpload v2.2.0.1: http://swfupload.org/ (MIT licensed http://www.opensource.org/licenses/mit-license.php)
 133     * SWFObject v2.1: http://code.google.com/p/swfobject/ (MIT licensed http://www.opensource.org/licenses/mit-license.php)
 134     * Sample markup and stylesheets from Sakai v2.5 (http://sakaiproject.org) and uPortal v2.6 (http://www.uportal.org/)
 135     * FCKeditor v2.6, HTML text editor (LGPL licensed http://www.fckeditor.net/license)
 136
 137 Other third party software
 138
 139     * fastXmlPull is based on XML for Script's Fast Pull Parser v3.1
 140       (see: http://wiki.fluidproject.org/display/fluid/Licensing+for+fastXmlPull.js )
 141     * fluid.reset.css is based on YUI's CSS reset styling v2.5.2
 142       see: http://developer.yahoo.com/yui/reset/ (BSD licensed http://developer.yahoo.com/yui/license.html)
 143
 144 Readme
 145 ------
 146 This file.
 147         README.txt
 148
 149
 150 Documentation
 151 =============
 152
 153     http://wiki.fluidproject.org/display/fluid/Infusion+Documentation
 154
 155 The Fluid Project uses a wiki for documentation and project collaboration: http://wiki.fluidproject.org.
 156
 157 The documentation for Infusion consists of a number of information pages stored in the Fluid Wiki.
 158 The pages include tutorials, API descriptions, testing procedures, and data-gathering approaches. To make the
 159 manual pages easy to navigate we have added the following guides:
 160
 161     * A landing page is provided for the reader, with links to all of our documenation.
 162     * A link to the documentation appears at the top of the left-side wiki navigation
 163       bar with the name "Infusion Documentation".
 164
 165
 166 Supported Browsers
 167 ==================
 168 Firefox 2.x, 3.x: full support
 169 Internet Explorer 6.x, 7.x: full support
 170 Safari 3.1, Opera 9.6: full support (except keyboard interaction, which is not supported by these browsers)
 171
 172 Internet Explorer 8: preliminary support
 173
 174 For more information on Fluid Infusion browser support, please see:
 175     http://wiki.fluidproject.org/display/fluid/Browser+Support
 176
 177
 178 Status of Components and Framework Features
 179 ===========================================
 180
 181 Production: supports A-Grade browsers, stable for production usage across a wide range of
 182 applications and use cases
 183     * Fluid Skinning System
 184     * Infusion Framework Core
 185     * Inline Edit: Simple Text
 186     * Reorderer: List, Grid, Layout, Image
 187     * Undo
 188
 189 Preview: still growing, but with broad browser support. Expect new features in upcoming releases
 190     * Pager
 191     * Progress
 192     * UI Options
 193     * Uploader
 194     * Renderer
 195
 196 Sneak Peek: in development; APIs will change. Share your feedback, ideas, and code
 197     * Inline Edit: Dropdown
 198     * Inline Edit: Rich Text
 199     * Table of Contents
 200
 201
 202 Known Issues
 203 ============
 204
 205 The Fluid Project uses a JIRA website to track bugs: http://issues.fluidproject.org.
 206 Some of the known issues in this release are described here:
 207
 208 FSS:
 209     FLUID-2504: Flexible columns don't maintain proper alignment under certain conditions
 210     FLUID-2434: In IE, major font size changes break text positioning within form controls
 211     FLUID-2397: Opera doesn't seem to repaint certain css changes on the fly, requiring a refresh to see them
 212
 213 Framework:
 214     FLUID-2577 Renderer performance can be slow on IE 6 and 7 in some contexts.
 215
 216 Inline Edit:
 217     FLUID-1600 Pressing the "Tab" key to exit edit mode places focus on the wrong item
 218     FLUID-2536 Inline Edit test fails using IE 8
 219
 220 Uploader:
 221     FLUID-2582 Uploader is dependent on ProgressiveEnhancement.js, which is not included in InfusionAll.js
 222     FLUID-2895 The browse files button displays as a white box in IE 7 when running off the local system in Flash 10
 223     FLUID-2052 Cannot tab away from the "Browse Files" button with Flash 10; using FF3*
 224     FLUID-2032 Cannot Tab to the 'Browse More" button with Flash 10, using FF2*
 225     * For information related to known issues with Flash 10 compatibility,
 226       see http://wiki.fluidproject.org/x/kwZo
 227
 228 Layout Reorderer:
 229     FLUID-1540 Can't use keyboard reordering to move a nested reorderer to the right column, using IE6
 230     FLUID-2171 In IE, can't reorderer portlets containing Google components
 231     FLUID-858  Portlet Columns load with no padding between them in IE7
 232
 233 Pager:
 234     FLUID-2880 The Pager will be refactored. Note that as a result of this, there will be significant changes to the Pager API
 235     FLUID-2329 The self-rendering mode of the Pager is not the default mode
 236
 237 Reorderer:
 238     FLUID-539 Can't use the "Tab" key to navigate out of reorderable tabs
 239     FLUID-148 Edge case: visual position of drop target when droppable is at beginning or end of a row
 240     FLUID-118 Dragging an image offscreen or out of the frame has some unexpected results.
 241
 242 UI Options:
 243     FLUID-2398 Minimum font size control changes the text size even when the base size is larger then the minimum.
 244     FLUID-2481 "Links" selection does not work correctly in UIOptions
 245     FLUID-2506 Keyboard navigation inside the dialog breaks in simple layout mode: using FF
 246     FLUID-2524 scrolling the screen while the UI Options dialog is open, will cause it's contents to appear distorted: using IE
 247