You are here

README.txt in Views jQFX Galleria 7

Views jQFX: Galleria
----------------------------
This module is a Views jQFX addon that integrates the Galleria plugin with
views. The Views jQFX module is a dependency. Galleria is a highly themable,
versatile, and customizable javascript image gallery plugin.

Installation
----------------------------
1) If you have not already done so, get and install the dependencies:
   Chaos tools: http://drupal.org/project/ctools
   Views: http://drupal.org/project/views
   Views jQFX: http://drupal.org/project/views_jqfx
   Libraries: http://drupal.org/project/libraries
2) Place this module in your modules directory and enable it at admin/modules.
   It will appear in the views section.
3) Download the Galleria plugin and place it in
   your sites/<path>/libraries directory (usually sites/all/libraries).
   To get the plugin to go the project page (http://galleria.aino.se).
   The final directory structure should look like:

   '/sites/<path>/libraries/galleria/galleria.js' (Rename this file. See below.)
   '/sites/<path>/libraries/galleria/galleria.min.js' (Rename this file. See below.)
   '/sites/<path>/libraries/galleria/plugins/' (Your download may not come with plugins.)
   '/sites/<path>/libraries/galleria/themes/'
   '/sites/<path>/libraries/galleria/themes/classic/galleria.classic.js'
     etc...

   Note that the galleria plugin javascript files
   may have a version number and need to be renamed.
   Example: galleria-1.2.2.js would be renamed to galleria.js
   Example: galleria-1.2.2.min.js would be renamed to galleria.min.js
4) Create or edit your content type.
   Captions are created from the alt and title tag attributes
   of the images in the content type you wish to display.
   If you want to display captions you must have the ability
   to add these attributes to you image fields.
   To enable image attributes navigate to admin->structure->content types
   Select 'manage fields' in the content type(s)
   that will be displayed in the Galleria (or create a new content type).
   Edit the image field that you want to display
   and be sure that the 'alt' and 'title' boxes are checked.
   This will provide a textfield for adding information
   to uploaded images when creating or editing a node.
   If this is a new content type an image field will need to be created for it.
   You can add multiple image fields per node. Each image will become a slide.
5) Create the node and/or nodes that you wish to display
   under admin->content->add
6) Create a node view.
   If you are new to views you may want to find a tutorial for it.
   There are many out there.
   Only the images in the node view will be displayed in the Galleria.
   Navigate to admin->structure->views->add
   Name your view (ie. jQFX Galleria).
   Check the 'Create a page' and/or 'Create a block' view
   with display format 'jQFX' of 'fields'.
   Enter the maximum number of items to display. 30 is usually safe.
   I recommend not using the pager. Then hit 'Continue & edit'.
   Next to the fields, click 'add'.
   Check any image fields you wish to apply (ie. Content: Image)
   then click 'Add and configure fields'.
   The image formatter is not an concern.
   All image styles are added in the module settings.
   Add your filters, arguments, etc for the content.
7) Next to 'Format: jQFX' click 'settings'.
   Under jQFX type->FX settings, select 'Galleria'.
   This will open the fieldset for your Galleria settings options.
   Choose your settings. They should be pretty self explainatory.
   Then click 'Apply all displays' and save your view.

Notes:
----------------------------
These instructions will provide a very basic install.
Flexibility is provided by the power of views.
Combined with arguments, filters, panels, node overrides etc
the sky is the limit. Experiment.

For further information on Galleria options check out the project page.
http://galleria.aino.se/docs/1.2/

Adding themes
----------------------------
    Galleria 1.2 has only the classic theme prepackaged in the download.
    Place additional themes in the plugin themes directory.
    The directory structure should look like:
       '/sites/<path>/libraries/galleria/themes/dots/galleria.dots.js'
       '/sites/<path>/libraries/galleria/themes/fullscreen/galleria.fullscreen.js'
       '/sites/<path>/libraries/galleria/themes/miniml/galleria.miniml.js'
       '/sites/<path>/libraries/galleria/themes/twelve/galleria.twelve.js'

    Additional themes will be automatically detected.

Please post any comments, questions, or bugs in the issues queue of the Views
jQFX: Galleria project page on Drupal at
http://drupal.org/project/views_jqfx_galleria

File

README.txt
View source
  1. Views jQFX: Galleria
  2. ----------------------------
  3. This module is a Views jQFX addon that integrates the Galleria plugin with
  4. views. The Views jQFX module is a dependency. Galleria is a highly themable,
  5. versatile, and customizable javascript image gallery plugin.
  6. Installation
  7. ----------------------------
  8. 1) If you have not already done so, get and install the dependencies:
  9. Chaos tools: http://drupal.org/project/ctools
  10. Views: http://drupal.org/project/views
  11. Views jQFX: http://drupal.org/project/views_jqfx
  12. Libraries: http://drupal.org/project/libraries
  13. 2) Place this module in your modules directory and enable it at admin/modules.
  14. It will appear in the views section.
  15. 3) Download the Galleria plugin and place it in
  16. your sites//libraries directory (usually sites/all/libraries).
  17. To get the plugin to go the project page (http://galleria.aino.se).
  18. The final directory structure should look like:
  19. '/sites//libraries/galleria/galleria.js' (Rename this file. See below.)
  20. '/sites//libraries/galleria/galleria.min.js' (Rename this file. See below.)
  21. '/sites//libraries/galleria/plugins/' (Your download may not come with plugins.)
  22. '/sites//libraries/galleria/themes/'
  23. '/sites//libraries/galleria/themes/classic/galleria.classic.js'
  24. etc...
  25. Note that the galleria plugin javascript files
  26. may have a version number and need to be renamed.
  27. Example: galleria-1.2.2.js would be renamed to galleria.js
  28. Example: galleria-1.2.2.min.js would be renamed to galleria.min.js
  29. 4) Create or edit your content type.
  30. Captions are created from the alt and title tag attributes
  31. of the images in the content type you wish to display.
  32. If you want to display captions you must have the ability
  33. to add these attributes to you image fields.
  34. To enable image attributes navigate to admin->structure->content types
  35. Select 'manage fields' in the content type(s)
  36. that will be displayed in the Galleria (or create a new content type).
  37. Edit the image field that you want to display
  38. and be sure that the 'alt' and 'title' boxes are checked.
  39. This will provide a textfield for adding information
  40. to uploaded images when creating or editing a node.
  41. If this is a new content type an image field will need to be created for it.
  42. You can add multiple image fields per node. Each image will become a slide.
  43. 5) Create the node and/or nodes that you wish to display
  44. under admin->content->add
  45. 6) Create a node view.
  46. If you are new to views you may want to find a tutorial for it.
  47. There are many out there.
  48. Only the images in the node view will be displayed in the Galleria.
  49. Navigate to admin->structure->views->add
  50. Name your view (ie. jQFX Galleria).
  51. Check the 'Create a page' and/or 'Create a block' view
  52. with display format 'jQFX' of 'fields'.
  53. Enter the maximum number of items to display. 30 is usually safe.
  54. I recommend not using the pager. Then hit 'Continue & edit'.
  55. Next to the fields, click 'add'.
  56. Check any image fields you wish to apply (ie. Content: Image)
  57. then click 'Add and configure fields'.
  58. The image formatter is not an concern.
  59. All image styles are added in the module settings.
  60. Add your filters, arguments, etc for the content.
  61. 7) Next to 'Format: jQFX' click 'settings'.
  62. Under jQFX type->FX settings, select 'Galleria'.
  63. This will open the fieldset for your Galleria settings options.
  64. Choose your settings. They should be pretty self explainatory.
  65. Then click 'Apply all displays' and save your view.
  66. Notes:
  67. ----------------------------
  68. These instructions will provide a very basic install.
  69. Flexibility is provided by the power of views.
  70. Combined with arguments, filters, panels, node overrides etc
  71. the sky is the limit. Experiment.
  72. For further information on Galleria options check out the project page.
  73. http://galleria.aino.se/docs/1.2/
  74. Adding themes
  75. ----------------------------
  76. Galleria 1.2 has only the classic theme prepackaged in the download.
  77. Place additional themes in the plugin themes directory.
  78. The directory structure should look like:
  79. '/sites//libraries/galleria/themes/dots/galleria.dots.js'
  80. '/sites//libraries/galleria/themes/fullscreen/galleria.fullscreen.js'
  81. '/sites//libraries/galleria/themes/miniml/galleria.miniml.js'
  82. '/sites//libraries/galleria/themes/twelve/galleria.twelve.js'
  83. Additional themes will be automatically detected.
  84. Please post any comments, questions, or bugs in the issues queue of the Views
  85. jQFX: Galleria project page on Drupal at
  86. http://drupal.org/project/views_jqfx_galleria