You are here

README.txt in Widgets 6

// --------------------------------------------------------
// Prerequisites

Widgets depends on the modules jquery_update and jquery_ui. The current version
of jquery_ui, 6.x.1.3, ships with jQuery UI version 1.6. The jQuery Multiselect
widget requires jQuery UI version 1.7. Follow the directions to upgraded jQuery UI
to version 1.7 in the README.txt of the jquery_ui module.

Also, the module depends on jQuery version 1.3.x. The version of jquery_update you
should use is currently 6.x.2.x-DEV.

// --------------------------------------------------------
// Installation

1.	Download Widgets module to your modules directory, usually
		sites/all/modules

2.	Download jQuery Multiselect from <http://github.com/michael/multiselect/>
		While developing this module version 0.3 of jQuery Multiselect was used,
		but later releases should work as well.

3.	Place the multiselect folder in the js folder of the widgets module,
		sites/all/modules/widgets/js/multiselect. The name of the unpacked multiselect
		folder downloaded in previous step may vary, for example the package I downloaded
		was named "michael-multiselect-6460fe9". Make sure you name the folder
		"multiselect" and place in the the js folder of the Widgets module. The full
		path to the script should be "sites/all/modules/widgets/js/multiselect/ui.multiselect.js".

4.	Activate module at "Administer > Modules"

5.	Go to "Administer > Site building > Blocks" and place the new block "Widgets"
		in a region of your choice.

// --------------------------------------------------------
// Usage

*		First go to "Administer > Site Settings > Widgets" and select the
		content type(s) you want available as widgets.

*		Enable widgets for a content type by going to "Content > Content types"
		and for each type you want to enable widgets for click "Widgets" tab
		on content type settings page and choose to enable widgets.

*		Create a widget by creating a new node of the type(s) you marked
		as widget types.

*		Create a new node of a type you activated widget support for. A new
		set of form elements should appear on the node form. Select the
		widgets you want for the page and click save.


// --------------------------------------------------------
// Troubleshooting

Q:	The "Widgets" tab doesn't appear on the content type settings page after the
		module has been installed.
A:	Clear the cache at "Adminster > Site Settings > Performance".

// --------------------------------------------------------
// History

2009-Nov-20 - 6.x-1.0-BETA2
Added missing files and clarified installation instructions.

2009-Nov-18 - 6.x-1.0-BETA1
First release.

// --------------------------------------------------------
// Credits

Widgets developed and maintained by Peter Törnstrand <http://drupal.org/user/293786>
Project sponsored by Happiness <http://www.happiness.se/>

File

README.txt
View source
  1. // --------------------------------------------------------
  2. // Prerequisites
  3. Widgets depends on the modules jquery_update and jquery_ui. The current version
  4. of jquery_ui, 6.x.1.3, ships with jQuery UI version 1.6. The jQuery Multiselect
  5. widget requires jQuery UI version 1.7. Follow the directions to upgraded jQuery UI
  6. to version 1.7 in the README.txt of the jquery_ui module.
  7. Also, the module depends on jQuery version 1.3.x. The version of jquery_update you
  8. should use is currently 6.x.2.x-DEV.
  9. // --------------------------------------------------------
  10. // Installation
  11. 1. Download Widgets module to your modules directory, usually
  12. sites/all/modules
  13. 2. Download jQuery Multiselect from
  14. While developing this module version 0.3 of jQuery Multiselect was used,
  15. but later releases should work as well.
  16. 3. Place the multiselect folder in the js folder of the widgets module,
  17. sites/all/modules/widgets/js/multiselect. The name of the unpacked multiselect
  18. folder downloaded in previous step may vary, for example the package I downloaded
  19. was named "michael-multiselect-6460fe9". Make sure you name the folder
  20. "multiselect" and place in the the js folder of the Widgets module. The full
  21. path to the script should be "sites/all/modules/widgets/js/multiselect/ui.multiselect.js".
  22. 4. Activate module at "Administer > Modules"
  23. 5. Go to "Administer > Site building > Blocks" and place the new block "Widgets"
  24. in a region of your choice.
  25. // --------------------------------------------------------
  26. // Usage
  27. * First go to "Administer > Site Settings > Widgets" and select the
  28. content type(s) you want available as widgets.
  29. * Enable widgets for a content type by going to "Content > Content types"
  30. and for each type you want to enable widgets for click "Widgets" tab
  31. on content type settings page and choose to enable widgets.
  32. * Create a widget by creating a new node of the type(s) you marked
  33. as widget types.
  34. * Create a new node of a type you activated widget support for. A new
  35. set of form elements should appear on the node form. Select the
  36. widgets you want for the page and click save.
  37. // --------------------------------------------------------
  38. // Troubleshooting
  39. Q: The "Widgets" tab doesn't appear on the content type settings page after the
  40. module has been installed.
  41. A: Clear the cache at "Adminster > Site Settings > Performance".
  42. // --------------------------------------------------------
  43. // History
  44. 2009-Nov-20 - 6.x-1.0-BETA2
  45. Added missing files and clarified installation instructions.
  46. 2009-Nov-18 - 6.x-1.0-BETA1
  47. First release.
  48. // --------------------------------------------------------
  49. // Credits
  50. Widgets developed and maintained by Peter Törnstrand
  51. Project sponsored by Happiness