README 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. -------------------------------------------------------------------------------
  2. dojox.image - Image Related Widgets and Components
  3. -------------------------------------------------------------------------------
  4. Version 1.0
  5. Release date: 10/31/07
  6. -------------------------------------------------------------------------------
  7. Project state:
  8. [Badge] experimental
  9. [FlickrBadge] experimental
  10. [Gallery] experimental
  11. [Lightbox] beta
  12. [Magnifier] experimental
  13. [MagnifierLite] experimental
  14. [SlideShow] experimental
  15. [ThumbnailPicker] experimental
  16. -------------------------------------------------------------------------------
  17. Credits
  18. [Badge] Peter Higgins (dante)
  19. [FlickrBadge] Bryan Forbes (BryanForbes)
  20. [Gallery] Shane O'Sullivan (sos)
  21. [Lightbox] Peter Higgins (dante)
  22. [Magnifier] Peter Higgins (dante)
  23. [MagnifierLite] Peter Higgins (dante)
  24. [SlideShow] Shane O'Sullivan (sos)
  25. [ThumbnailPicker] Shane O'Sullivan (sos)
  26. -------------------------------------------------------------------------------
  27. Project description
  28. A class to provide a common API for images, and home for image
  29. related Widgets.
  30. -------------------------------------------------------------------------------
  31. Dependencies:
  32. LightBox: dojo core, dojox.fx and optionally dojox.data. uses
  33. either tundra or soria theme, no standalone icons.
  34. SlideShow: dojo core, dojo.fx, and dojo.data (optional
  35. dojox.data store implementations apply)
  36. ThumbNailPicker: dojo core, dojo.fx and dojo.data. Combined
  37. with a SlideShow, creates a sample Gallery app.
  38. Gallery: core, dojox.image.SlideShow, dojox.image.ThumbNailPicker
  39. Magnifier: (prototype) dojo core, dijit._Widget, dojox.gfx
  40. Badge: (prototype) dojo core, dijit._Widget + _Templated
  41. -------------------------------------------------------------------------------
  42. Documentation
  43. -------------------------------------------------------------------------------
  44. Installation instructions
  45. Grab the following from the Dojo SVN Repository:
  46. http://svn.dojotoolkit.org/dojo/dojox/trunk/image/*
  47. Install into the following directory structure:
  48. /dojox/image/
  49. ...which should be at the same level as your Dojo checkout.
  50. -------------------------------------------------------------------------------
  51. Additional Notes
  52. LightBox: currently works as individual items, and grouped items,
  53. but usage of dojo.data is broken (atm). the API is subject to
  54. change, and is marked accordingly.
  55. Hoping to implement: Carossel, and Reflect using
  56. a common API provided by dojox.image.Pane (?)
  57. SlideShow: Shows an image, one by one, from a datastore. Acts
  58. as standing ImagePane implementation,
  59. Gallery: A combination Thumbnail view and SlideShow, using
  60. a datastore, and providing navigation, and common API.
  61. Magnifier: Unobtrusive way to attach a hovering window window
  62. when moving the mouse over an image. The window shows a a zoomed
  63. version of the original source. (prototype)
  64. Badge: (prototype) A Javascript version of a FlickrBadge thingr,
  65. which loops through and sizes children in a loop.