You are here

Home » API reference » Dynamic display block 6

README.txt in Dynamic display block 6

Same filename and directory in other branches
  1. 7 README.txt
Note: This is a development version after RC6 of the module for testing purpose only. 
Don't use it to replace RC6. Please test and review the module and post your issues 
in the issue queue of the module http://drupal.org/project/issues/ddblock 
to test and improve the module, so we can release a new version. The module is tested
by us and should work properly, although we are sure bugs can be found and there are a 
lot of code improvements possible. 


SUMMARY
-------
The Dynamic display block module enables you to create blocks to present content
in a dynamic way. For creating slideshow effects it uses the jQuery Cycle plug-in.

There are four ways to specify content for the Dynamic display block module:

* A folder containing image files
* A node from a content type with multiple input
* CCK and Views
* An instance of any created block

The headerimage module or CCK and Views makes retrieving and displaying content with
the Dynamic display block module very flexible.

Several effects and other setting can be set in the configuration settings of the
Dynamic display block module.


MORE INFORMATION
----------------
You can find more information in the handbook pages on Drupal.org
http://drupal.org/node/293714

Other tutorials can be found on http://ddblock.myalbums.biz
Basic tutorial: http://ddblock.myalbums.biz/tutorial
Advanced slideshow tutorial: http://ddblock.myalbums.biz/node/747

Frequenly asked questions on http://ddblock.myalbums.biz/faq

You can see a demo of the module at http://ddblock.myalbums.biz/


REQUIREMENTS
------------
jQuery-update module.

Note: From Drupal 6.3, Drupal includes jQuery 1.2.6., but still we prefer to install
      jQuery update module for future versions of jQuery. (soon 1.3.x)

See INSTALL.txt


INSTALLATION
------------
See INSTALL.txt


COLLABORATION WITH OTHER MODULES
--------------------------------
The dynamic display block module can work together with all modules that provide
blocks. The content of the block can be displayed dynamically (one by one width
transition effects) if the content consist of e.g. Images, A list of listitems,
A table with tablerows, etc.

Example modules and blocks you can use

Module       - blocks
---------------------
Headerimage  - blocks with images
Comments     - Recent comments
Forum        - Active forum topics
Forum        - New forum topics
CCK          - Content types
Views        - blocks with images, lists, tables
Worldclock   - World clock
etc.

* Set the blocks you want to use with the dynamic display block module in
  Administer >> Site configuration >> Dynamic display block - Settings tab.

* Make an instance of the block you want to use in Administer >> Site
  configuration >> Dynamic display block - Instance tab.

* Configure the block in Administer >> Site configuration >> Dynamic display
  block - List tab.

  Dont forget to set the Container value to the tag you want to show

* Add the block to a region in in Administer >> Site Building >> Blocks.

CONFIGURATION
-------------
* Configure user permissions in Administer >> User management >> Permissions
  >> ddblock module:

  - administer dynamic display blocks:

  - view dynamic display blocks:

* Customize module settings in Administer >> Site configuration >> Dynamic
  display block.

  - Create a dynamic display block and configure the block (leave all default settings).

  - Place some pictures in the /files/images/ddblock folder (.jpg, .gif or .png) files.

  - Navigate to Administer > Site building > Blocks

  - Place the block in one of the regions of your Site.

* Settings:

Input type: Which content to use with the dynamic display block

Image folder settings:

 - Image Folder: The folder containing image files to be used as the content of
   dynamic display block. Use a relative path. The default is files/images/ddblock

 - Number of images: The number of images to show in the block.

Content type settings:

 - Content Type: The nodes of the content type to be used as content of dynamic display
   block.

 - Node: The node to show in the Dynamic display block.

Content container settings:

 - Content container: Container of the content to show, eg. img, to show images.

 - Height: Height of the content to show.

 - Width: Width of the content to show.

Image settings:

 - Height: Height of the image to show.

 - Width: Width of the image to show.

Settings:

 - Transition Effect: The transition effect between content.

 - Speed: Speed of the transitions (1000 = 1 second).

 - Timeout: The time (in Milliseconds) between transitions (1000 = 1 second, 0 to
   disable auto advance).

 - Sort Order: The display order of the content.

 - Pause: Enable users to pause the cycle by hovering on the content.

 - Next: Enable users to advanced to the next content by clicking on the content.

 - Pager: Add a number pager or an image pager to a dynamic display block.
          You can only add a image pager if your use images from an image folder.

 - Pager_height: Height of the pager.

 - Pager_width: Width of the pager.

Custom Settings:

 - Custom Options: Add or override custom options for the cycle plug-in.
                   The settings transition effect, container and pager from
                   the settings are used, but can be overriden.

ADVANCED SLIDESHOWS
-------------------
See the Advanced slideshow tutorial on http://ddblock.myalbums.biz/node/747 for a
tutorial how to make advanced slideshows.

TROUBLESHOOTING
---------------
* If a dynamic display block is not displayed, check the following steps:

  - Is the 'view dynamic display blocks' permission enabled?
  - Did you put the block in one of the regions?

  Also have a look in the FAQ


FAQ
---
For Frequently Asked Questions - http://ddblock.myalbums.biz/faq


CONTACT
-------
Original idea cycle module by roopletheme - http://drupal.org/user/164625

Major rewrite by current Maintainers:
* Philip Blaauw (ppblaauw) - http://drupal.org/user/155138
* Iren T. Biasong (iren_cruz) - http://drupal.org/user/305000

We also offer installation, development, theming, customization.
You can contact us via the contact form on http://ddblock.myalbums.biz.
or via email to ppblaauw (at) gmail.com

File

README.txt
View source 
  1. 

  2. Note: This is a development version after RC6 of the module for testing purpose only. 

  3. Don't use it to replace RC6. Please test and review the module and post your issues 

  4. in the issue queue of the module http://drupal.org/project/issues/ddblock 

  5. to test and improve the module, so we can release a new version. The module is tested

  6. by us and should work properly, although we are sure bugs can be found and there are a 

  7. lot of code improvements possible. 

  8. 

  9. 

  10. SUMMARY

  11. -------

  12. The Dynamic display block module enables you to create blocks to present content

  13. in a dynamic way. For creating slideshow effects it uses the jQuery Cycle plug-in.

  14. 

  15. There are four ways to specify content for the Dynamic display block module:

  16. 

  17. * A folder containing image files

  18. * A node from a content type with multiple input

  19. * CCK and Views

  20. * An instance of any created block

  21. 

  22. The headerimage module or CCK and Views makes retrieving and displaying content with

  23. the Dynamic display block module very flexible.

  24. 

  25. Several effects and other setting can be set in the configuration settings of the

  26. Dynamic display block module.

  27. 

  28. 

  29. MORE INFORMATION

  30. ----------------

  31. You can find more information in the handbook pages on Drupal.org

  32. http://drupal.org/node/293714

  33. 

  34. Other tutorials can be found on http://ddblock.myalbums.biz

  35. Basic tutorial: http://ddblock.myalbums.biz/tutorial

  36. Advanced slideshow tutorial: http://ddblock.myalbums.biz/node/747

  37. 

  38. Frequenly asked questions on http://ddblock.myalbums.biz/faq

  39. 

  40. You can see a demo of the module at http://ddblock.myalbums.biz/

  41. 

  42. 

  43. REQUIREMENTS

  44. ------------

  45. jQuery-update module.

  46. 

  47. Note: From Drupal 6.3, Drupal includes jQuery 1.2.6., but still we prefer to install

  48.       jQuery update module for future versions of jQuery. (soon 1.3.x)

  49. 

  50. See INSTALL.txt

  51. 

  52. 

  53. INSTALLATION

  54. ------------

  55. See INSTALL.txt

  56. 

  57. 

  58. COLLABORATION WITH OTHER MODULES

  59. --------------------------------

  60. The dynamic display block module can work together with all modules that provide

  61. blocks. The content of the block can be displayed dynamically (one by one width

  62. transition effects) if the content consist of e.g. Images, A list of listitems,

  63. A table with tablerows, etc.

  64. 

  65. Example modules and blocks you can use

  66. 

  67. Module       - blocks

  68. ---------------------

  69. Headerimage  - blocks with images

  70. Comments     - Recent comments

  71. Forum        - Active forum topics

  72. Forum        - New forum topics

  73. CCK          - Content types

  74. Views        - blocks with images, lists, tables

  75. Worldclock   - World clock

  76. etc.

  77. 

  78. * Set the blocks you want to use with the dynamic display block module in

  79.   Administer >> Site configuration >> Dynamic display block - Settings tab.

  80. 

  81. * Make an instance of the block you want to use in Administer >> Site

  82.   configuration >> Dynamic display block - Instance tab.

  83. 

  84. * Configure the block in Administer >> Site configuration >> Dynamic display

  85.   block - List tab.

  86. 

  87.   Dont forget to set the Container value to the tag you want to show

  88. 

  89. * Add the block to a region in in Administer >> Site Building >> Blocks.

  90. 

  91. CONFIGURATION

  92. -------------

  93. * Configure user permissions in Administer >> User management >> Permissions

  94.   >> ddblock module:

  95. 

  96.   - administer dynamic display blocks:

  97. 

  98.   - view dynamic display blocks:

  99. 

  100. * Customize module settings in Administer >> Site configuration >> Dynamic

  101.   display block.

  102. 

  103.   - Create a dynamic display block and configure the block (leave all default settings).

  104. 

  105.   - Place some pictures in the /files/images/ddblock folder (.jpg, .gif or .png) files.

  106. 

  107.   - Navigate to Administer > Site building > Blocks

  108. 

  109.   - Place the block in one of the regions of your Site.

  110. 

  111. * Settings:

  112. 

  113. Input type: Which content to use with the dynamic display block

  114. 

  115. Image folder settings:

  116. 

  117.  - Image Folder: The folder containing image files to be used as the content of

  118.    dynamic display block. Use a relative path. The default is files/images/ddblock

  119. 

  120.  - Number of images: The number of images to show in the block.

  121. 

  122. Content type settings:

  123. 

  124.  - Content Type: The nodes of the content type to be used as content of dynamic display

  125.    block.

  126. 

  127.  - Node: The node to show in the Dynamic display block.

  128. 

  129. Content container settings:

  130. 

  131.  - Content container: Container of the content to show, eg. img, to show images.

  132. 

  133.  - Height: Height of the content to show.

  134. 

  135.  - Width: Width of the content to show.

  136. 

  137. Image settings:

  138. 

  139.  - Height: Height of the image to show.

  140. 

  141.  - Width: Width of the image to show.

  142. 

  143. Settings:

  144. 

  145.  - Transition Effect: The transition effect between content.

  146. 

  147.  - Speed: Speed of the transitions (1000 = 1 second).

  148. 

  149.  - Timeout: The time (in Milliseconds) between transitions (1000 = 1 second, 0 to

  150.    disable auto advance).

  151. 

  152.  - Sort Order: The display order of the content.

  153. 

  154.  - Pause: Enable users to pause the cycle by hovering on the content.

  155. 

  156.  - Next: Enable users to advanced to the next content by clicking on the content.

  157. 

  158.  - Pager: Add a number pager or an image pager to a dynamic display block.

  159.           You can only add a image pager if your use images from an image folder.

  160. 

  161.  - Pager_height: Height of the pager.

  162. 

  163.  - Pager_width: Width of the pager.

  164. 

  165. Custom Settings:

  166. 

  167.  - Custom Options: Add or override custom options for the cycle plug-in.

  168.                    The settings transition effect, container and pager from

  169.                    the settings are used, but can be overriden.

  170. 

  171. ADVANCED SLIDESHOWS

  172. -------------------

  173. See the Advanced slideshow tutorial on http://ddblock.myalbums.biz/node/747 for a

  174. tutorial how to make advanced slideshows.

  175. 

  176. TROUBLESHOOTING

  177. ---------------

  178. * If a dynamic display block is not displayed, check the following steps:

  179. 

  180.   - Is the 'view dynamic display blocks' permission enabled?

  181.   - Did you put the block in one of the regions?

  182. 

  183.   Also have a look in the FAQ

  184. 

  185. 

  186. FAQ

  187. ---

  188. For Frequently Asked Questions - http://ddblock.myalbums.biz/faq

  189. 

  190. 

  191. CONTACT

  192. -------

  193. Original idea cycle module by roopletheme - http://drupal.org/user/164625

  194. 

  195. Major rewrite by current Maintainers:

  196. * Philip Blaauw (ppblaauw) - http://drupal.org/user/155138

  197. * Iren T. Biasong (iren_cruz) - http://drupal.org/user/305000

  198. 

  199. We also offer installation, development, theming, customization.

  200. You can contact us via the contact form on http://ddblock.myalbums.biz.

  201. or via email to ppblaauw (at) gmail.com