You are here

README.txt in Slick Media 8.2

Same filename and directory in other branches
  1. 8.3 README.txt
  2. 8 README.txt
ABOUT

Provides integration between Slick carousel and Media entity. Slick media allows
richer slideshow/carousel contents with a mix of text, image and video.

This provides a Slick media formatter for the supported Media entities:
  o Media entity image
  o Media entity embeddable video


REQUIREMENTS
[1] http://dgo.to/slick
[2] http://dgo.to/media_entity_image
[3] http://dgo.to/media_entity_embeddable_video

The last 2 modules depend on Media entity.


INSTALLATION
Install the module as usual, more info can be found on:
http://drupal.org/documentation/install/modules-themes/modules-7

Enable Slick media module under "Slick" package:
/admin/modules#edit-modules-slick

USAGE / CONFIGURATION
- Enable this module and its dependencies mentioned above.

- At admin/config/people/accounts/fields, Content types or any fieldable entity,
  -- click "Manage display".

- Under "Format", choose "Slick media" for Media entity reference field, and
  click the "Configure" icon.
  Adjust formatter options accordingly, including your optionset.
  Be sure a Media entity reference field is already added with the expected
  fields for title, caption, image and video. And they are not hidden at the
  chosen View mode.

The more complex is your slide, the more options are available.


OPTIONSET
To create your optionsets, go to:

"admin/config/media/slick"


SLIDE LAYOUT
The slide layout option depends on at least a skin selected. No skin, just DIY.
A Media entity is fieldable entity so you can add custom field to hold layout
options. While core image field supports several caption placements/ layout that
affect the entire slides, the fieldable entity may have unique layout per slide
using a dedicated "List (text)" type with the following supported/pre-defined
keys:
top, right, bottom, left, center, below, e.g:

Option #1
---------

bottom|Caption bottom
top|Caption top
right|Caption right
left|Caption left
center|Caption center
center-top|Caption center top
below|Caption below the slide


Option #2
---------

If you have complex slide layout via Media entity with overlay video or images
within slide captions, also supported:

stage-right|Caption left, stage right
stage-left|Caption right, stage left


Option #3
---------

If you choose skin Split, additional layout options supported:

split-right|Caption left, stage right, split half
split-left|Caption right, stage left, split half


Split means image and caption are displayed side by side.

Specific to split layout, be sure to get consistent options (left and right)
per slide, and also choose optionset with skin Split to have a context per
slideshow. Otherwise layout per slideshow with reusable Media files will be
screwed up.

Except the "Caption below the slide" option, all is absolutely positioned aka
overlayed on top of the main slide image/ background for larger monitor.
Those layouts are ideally applied to large displays, not multiple small slides,
nor small carousels, except "Caption below the slide" which is reasonable with
small slides.


Option #4
---------

Merge all options as needed.


TROUBLESHOOTING
Be sure to first update Blazy and Slick prior to this module update.


AUTHOR/MAINTAINER/CREDITS
gausarts


READ MORE
See the project page on drupal.org: http://drupal.org/project/slick_media.

File

README.txt
View source
  1. ABOUT
  2. Provides integration between Slick carousel and Media entity. Slick media allows
  3. richer slideshow/carousel contents with a mix of text, image and video.
  4. This provides a Slick media formatter for the supported Media entities:
  5. o Media entity image
  6. o Media entity embeddable video
  7. REQUIREMENTS
  8. [1] http://dgo.to/slick
  9. [2] http://dgo.to/media_entity_image
  10. [3] http://dgo.to/media_entity_embeddable_video
  11. The last 2 modules depend on Media entity.
  12. INSTALLATION
  13. Install the module as usual, more info can be found on:
  14. http://drupal.org/documentation/install/modules-themes/modules-7
  15. Enable Slick media module under "Slick" package:
  16. /admin/modules#edit-modules-slick
  17. USAGE / CONFIGURATION
  18. - Enable this module and its dependencies mentioned above.
  19. - At admin/config/people/accounts/fields, Content types or any fieldable entity,
  20. -- click "Manage display".
  21. - Under "Format", choose "Slick media" for Media entity reference field, and
  22. click the "Configure" icon.
  23. Adjust formatter options accordingly, including your optionset.
  24. Be sure a Media entity reference field is already added with the expected
  25. fields for title, caption, image and video. And they are not hidden at the
  26. chosen View mode.
  27. The more complex is your slide, the more options are available.
  28. OPTIONSET
  29. To create your optionsets, go to:
  30. "admin/config/media/slick"
  31. SLIDE LAYOUT
  32. The slide layout option depends on at least a skin selected. No skin, just DIY.
  33. A Media entity is fieldable entity so you can add custom field to hold layout
  34. options. While core image field supports several caption placements/ layout that
  35. affect the entire slides, the fieldable entity may have unique layout per slide
  36. using a dedicated "List (text)" type with the following supported/pre-defined
  37. keys:
  38. top, right, bottom, left, center, below, e.g:
  39. Option #1
  40. ---------
  41. bottom|Caption bottom
  42. top|Caption top
  43. right|Caption right
  44. left|Caption left
  45. center|Caption center
  46. center-top|Caption center top
  47. below|Caption below the slide
  48. Option #2
  49. ---------
  50. If you have complex slide layout via Media entity with overlay video or images
  51. within slide captions, also supported:
  52. stage-right|Caption left, stage right
  53. stage-left|Caption right, stage left
  54. Option #3
  55. ---------
  56. If you choose skin Split, additional layout options supported:
  57. split-right|Caption left, stage right, split half
  58. split-left|Caption right, stage left, split half
  59. Split means image and caption are displayed side by side.
  60. Specific to split layout, be sure to get consistent options (left and right)
  61. per slide, and also choose optionset with skin Split to have a context per
  62. slideshow. Otherwise layout per slideshow with reusable Media files will be
  63. screwed up.
  64. Except the "Caption below the slide" option, all is absolutely positioned aka
  65. overlayed on top of the main slide image/ background for larger monitor.
  66. Those layouts are ideally applied to large displays, not multiple small slides,
  67. nor small carousels, except "Caption below the slide" which is reasonable with
  68. small slides.
  69. Option #4
  70. ---------
  71. Merge all options as needed.
  72. TROUBLESHOOTING
  73. Be sure to first update Blazy and Slick prior to this module update.
  74. AUTHOR/MAINTAINER/CREDITS
  75. gausarts
  76. READ MORE
  77. See the project page on drupal.org: http://drupal.org/project/slick_media.