docs/include/jscripts/infusion/README.txt

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