You are here

README.txt in Slick Carousel 7.2

Same filename in this branch
  1. 7.2 README.txt
  2. 7.2 slick_fields/README.txt
Slick Fields Module
================================================================================

Adds a field display formatter to allow you to display field content using
Slick carousel. The module doesn't require Field UI to be enabled by default
(so you can leave it off once everything is configured) but it is recommended
to use to setup your display settings.


SUPPORTED FIELDS:
--------------------------------------------------------------------------------
- Image
- Media
- Field collection

Additional supported fields:
- Scald for audio/video overlay, alternative to Media, within Field collection
- Color field module to colorize individual slide text within Field collection


USAGE:
--------------------------------------------------------------------------------

Manage the fields on any entity (e.g.: node of type Article):

"admin/structure/types/manage/article/display"

Select any field of type "Image", "Media file" or "Field collection" and set the
display options to "Slick carousel" under "Format".
Adjust formatter options accordingly, including your option set.

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

If using Media or Field collection, make sure to provide relevant View mode,
and the fields are made visible at their own Manage display page.


OPTIONSETS:
--------------------------------------------------------------------------------

To create your option sets, go to:

"admin/config/media/slick"


SLIDE LAYOUTS:
--------------------------------------------------------------------------------
Core image field supports several caption placements/ layout that affect the
entire slides.

If you have more complex need, use Media or Field collection.
You can place caption in several positions per individual slide as long as you
provide a dedicated List (text) 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 or Field collection 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 at a slight distance.

Specific to split layout, make 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.
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.


NOTES (deprecated):
--------------------------------------------------------------------------------
Current slick do not support variable height, so even short slides will have the
tallest heights, so use consistent relevant Slide layout options above, e.g.:
Mixing "Caption below the slide" with others will result inconsistent heights.

NOTES (updated):
--------------------------------------------------------------------------------
As of version 1.3.10 (or so ?), there is option adaptiveHeight that support
variable height.

More info relevant to each option is available at their form display by hovering
over them, and click a dark question mark.

File

slick_fields/README.txt
View source
  1. Slick Fields Module
  2. ================================================================================
  3. Adds a field display formatter to allow you to display field content using
  4. Slick carousel. The module doesn't require Field UI to be enabled by default
  5. (so you can leave it off once everything is configured) but it is recommended
  6. to use to setup your display settings.
  7. SUPPORTED FIELDS:
  8. --------------------------------------------------------------------------------
  9. - Image
  10. - Media
  11. - Field collection
  12. Additional supported fields:
  13. - Scald for audio/video overlay, alternative to Media, within Field collection
  14. - Color field module to colorize individual slide text within Field collection
  15. USAGE:
  16. --------------------------------------------------------------------------------
  17. Manage the fields on any entity (e.g.: node of type Article):
  18. "admin/structure/types/manage/article/display"
  19. Select any field of type "Image", "Media file" or "Field collection" and set the
  20. display options to "Slick carousel" under "Format".
  21. Adjust formatter options accordingly, including your option set.
  22. The more complex is your slide, the more options are available.
  23. If using Media or Field collection, make sure to provide relevant View mode,
  24. and the fields are made visible at their own Manage display page.
  25. OPTIONSETS:
  26. --------------------------------------------------------------------------------
  27. To create your option sets, go to:
  28. "admin/config/media/slick"
  29. SLIDE LAYOUTS:
  30. --------------------------------------------------------------------------------
  31. Core image field supports several caption placements/ layout that affect the
  32. entire slides.
  33. If you have more complex need, use Media or Field collection.
  34. You can place caption in several positions per individual slide as long as you
  35. provide a dedicated List (text) with the following supported/pre-defined keys:
  36. top, right, bottom, left, center, below, e.g:
  37. Option #1
  38. ---------
  39. bottom|Caption bottom
  40. top|Caption top
  41. right|Caption right
  42. left|Caption left
  43. center|Caption center
  44. center-top|Caption center top
  45. below|Caption below the slide
  46. Option #2
  47. ---------
  48. If you have complex slide layout via Media or Field collection with overlay
  49. video or images within slide captions, also supported:
  50. stage-right|Caption left, stage right
  51. stage-left|Caption right, stage left
  52. Option #3
  53. ---------
  54. If you choose skin Split, additional layout options supported:
  55. split-right|Caption left, stage right, split half
  56. split-left|Caption right, stage left, split half
  57. Split means image and caption are displayed side by side at a slight distance.
  58. Specific to split layout, make sure to get consistent options (left and right)
  59. per slide, and also choose optionset with skin Split to have a context per
  60. slideshow. Otherwise layout per slideshow with reusable Media files will be
  61. screwed up.
  62. Except the "Caption below the slide" option, all is absolutely positioned aka
  63. overlayed on top of the main slide image/ background.
  64. Those layouts are ideally applied to large displays, not multiple small slides,
  65. nor small carousels, except "Caption below the slide" which is reasonable with
  66. small slides.
  67. Option #4
  68. ---------
  69. Merge all options as needed.
  70. NOTES (deprecated):
  71. --------------------------------------------------------------------------------
  72. Current slick do not support variable height, so even short slides will have the
  73. tallest heights, so use consistent relevant Slide layout options above, e.g.:
  74. Mixing "Caption below the slide" with others will result inconsistent heights.
  75. NOTES (updated):
  76. --------------------------------------------------------------------------------
  77. As of version 1.3.10 (or so ?), there is option adaptiveHeight that support
  78. variable height.
  79. More info relevant to each option is available at their form display by hovering
  80. over them, and click a dark question mark.