jscripts/infusion/components/uploader/ReadMe.txt

   1 Infusion Uploader Read Me
   2
   3 1) Upgrading
   4 2) Known Issues
   5 3) Troubleshooting
   6 4) Running the Uploader with out a Server
   7
   8 --------------------------------------
   9
  10 UPGRADING from previous versions:
  11
  12 Before upgrading from Infusion 0.5 or earlier, please refer to the Uploader API documentation and the
  13 latest example code. The Fluid Uploader was extensively refactored in the 0.6 release, and a fresh new
  14 API has been introduced.
  15
  16 Please refer to the Uploader API documentation on the Fluid Wiki and the
  17 Infusion 1.0 example code before using the Uploader with an existing integration.
  18 http://wiki.fluidproject.org/display/fluid/Uploader+API
  19
  20 --------------------------------------
  21
  22 KNOWN ISSUES:
  23
  24 * To support Flash 10 (released on 9/26/2008), the Uploader required a new version of the SWFUpload
  25   Flash component (2.2.0 beta 3). This new version, still in beta, still has numerous bugs. We have
  26   worked around many of the bugs and inconsistencies in the SWFUpload code, but there are still
  27   significant compromises and issues in this release. For this reason we do not consider this version
  28   of the Uploader to be production-ready.
  29
  30   In the previous version of the Uploader, the Flash component worked completely "behind the scenes".
  31   To support Flash 10, the Uploader displays a Flash-based "Browse files..." button in place of a
  32   HTML button. The Flash-based button presents the following quirks:
  33
  34       In Firefox and IE, the Flash-based Browse button does not size correctly when the text/page
  35       is resized or zoomed.
  36
  37       In Firefox (FF):
  38       - The AIRA role for the Browse button is read correctly as "button" but the text of the button,
  39         "Browse Files", is ignored.
  40       - The Flash-based Browse button traps keyboard navigation, refusing to give up focus without a
  41         mouse click.
  42
  43       In Internet Explorer (IE):
  44       - AIRA is not supported by Internet Explorer.
  45
  46     We are exploring work-arounds for most of these issues, and will have a patch out as soon
  47     as possible to fix them.
  48
  49 * In previous versions of the Uploader the upload process would stop immediately at the moment that
  50   the Stop Upload button was clicked.
  51
  52   With Infusion 0.8, we wait for the current file to complete or to error before we stop the upload
  53   process. This avoids a serious bug in the SWFUploader where the Upload process could get stuck when
  54   the Upload process as resumed.
  55
  56
  57 --------------------------------------
  58
  59 TROUBLE SHOOTING:
  60
  61 * When running the Uploader sample code on a local system without a server, check to make
  62   sure that you have followed the instructions below under "RUNNING THE UPLOADER ON A
  63   LOCAL SYSTEM WITHOUT A SERVER".
  64
  65 * If you see this error in your console:
  66   [Exception... "'Invalid function name' when calling method: [nsIDOMEventListener::handleEvent]"
  67   nsresult: "0x8057001e (NS_ERROR_XPC_JS_THREW_STRING)" location: "<unknown>" data: no]
  68
  69   The flashUrl option is probably wrong. Check that first.
  70
  71
  72 --------------------------------------
  73
  74 RUNNING THE UPLOADER ON A LOCAL SYSTEM WITHOUT A SERVER
  75
  76 Running the Uploader locally without a server is intended for basic testing purposes only. The
  77 DemoUploadManager provides a simulated conversation with the server, but it doesn't represent a
  78 fully accurate picture of the component's behaviour when used in a real deployment environment.
  79
  80 So see the Uploader in action with a real server, have a look at Fluid's Image Gallery demo:
  81
  82 http://build.fluidproject.org:8080/sakai-imagegallery2-web/site/AddImages/
  83
  84
  85 Additionally, you may need to modify some of your Flash settings to allow the local SWFUpload
  86 object to access your file system. To do so, follow these directions:
  87
  88 1. Open your browser
  89 2. Browse to:
  90    http://www.macromedia.com/support/documentation/en/flashplayer/help/settings_manager04.html
  91 3. In the Flash Settings panel, click "Edit locations..."
  92 4. Select "Add location..."
  93 5. Click "Browse for folder..."
  94 6. Select the local /src/webapp/lib/swfupload/flash/ directory that contains the swfupload.swf file
  95 7. Restart your browser
  96
  97 You should be good to go!
  98
  99 However, if you move your installation, you'll need to do this all over again. There are settings
 100 that will allow the file to be run from any location on your local machine but these instructions
 101 are the minimum settings and therefor pose the least security risk.
 102
 103 These settings are global and do not need to repeated for every browser on a given system.