modules/ddblock/README.txt

// $Id: README.txt,v 1.4 2009/02/20 16:09:18 ppblaauw Exp $

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.

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
1	// $Id: README.txt,v 1.4 2009/02/20 16:09:18 ppblaauw Exp $
2
3	Note: This is a development version after RC6 of the module for testing purpose only.
4	Don't use it to replace RC6. Please test and review the module and post your issues
5	in the issue queue of the module http://drupal.org/project/issues/ddblock
6	to test and improve the module, so we can release a new version. The module is tested
7	by us and should work properly, although we are sure bugs can be found and there are a
8	lot of code improvements possible.
9
10
11	SUMMARY
12	-------
13	The Dynamic display block module enables you to create blocks to present content
14	in a dynamic way. For creating slideshow effects it uses the jQuery Cycle plug-in.
15
16	There are four ways to specify content for the Dynamic display block module:
17
18	* A folder containing image files
19	* A node from a content type with multiple input
20	* CCK and Views
21	* An instance of any created block
22
23	The headerimage module or CCK and Views makes retrieving and displaying content with
24	the Dynamic display block module very flexible.
25
26	Several effects and other setting can be set in the configuration settings of the
27	Dynamic display block module.
28
29
30	MORE INFORMATION
31	----------------
32	You can find more information in the handbook pages on Drupal.org
33	http://drupal.org/node/293714
34
35	Other tutorials can be found on http://ddblock.myalbums.biz
36	Basic tutorial: http://ddblock.myalbums.biz/tutorial
37	Advanced slideshow tutorial: http://ddblock.myalbums.biz/node/747
38
39	Frequenly asked questions on http://ddblock.myalbums.biz/faq
40
41	You can see a demo of the module at http://ddblock.myalbums.biz/
42
43
44	REQUIREMENTS
45	------------
46	jQuery-update module.
47
48	See INSTALL.txt
49
50
51	INSTALLATION
52	------------
53	See INSTALL.txt
54
55
56	COLLABORATION WITH OTHER MODULES
57	--------------------------------
58	The dynamic display block module can work together with all modules that provide
59	blocks. The content of the block can be displayed dynamically (one by one width
60	transition effects) if the content consist of e.g. Images, A list of listitems,
61	A table with tablerows, etc.
62
63	Example modules and blocks you can use
64
65	Module - blocks
66	---------------------
67	Headerimage - blocks with images
68	Comments - Recent comments
69	Forum - Active forum topics
70	Forum - New forum topics
71	CCK - Content types
72	Views - blocks with images, lists, tables
73	Worldclock - World clock
74	etc.
75
76	* Set the blocks you want to use with the dynamic display block module in
77	Administer >> Site configuration >> Dynamic display block - Settings tab.
78
79	* Make an instance of the block you want to use in Administer >> Site
80	configuration >> Dynamic display block - Instance tab.
81
82	* Configure the block in Administer >> Site configuration >> Dynamic display
83	block - List tab.
84
85	Dont forget to set the Container value to the tag you want to show
86
87	* Add the block to a region in in Administer >> Site Building >> Blocks.
88
89	CONFIGURATION
90	-------------
91	* Configure user permissions in Administer >> User management >> Permissions
92	>> ddblock module:
93
94	- administer dynamic display blocks:
95
96	- view dynamic display blocks:
97
98	* Customize module settings in Administer >> Site configuration >> Dynamic
99	display block.
100
101	- Create a dynamic display block and configure the block (leave all default settings).
102
103	- Place some pictures in the /files/images/ddblock folder (.jpg, .gif or .png) files.
104
105	- Navigate to Administer > Site building > Blocks
106
107	- Place the block in one of the regions of your Site.
108
109	* Settings:
110
111	Input type: Which content to use with the dynamic display block
112
113	Image folder settings:
114
115	- Image Folder: The folder containing image files to be used as the content of
116	dynamic display block. Use a relative path. The default is files/images/ddblock
117
118	- Number of images: The number of images to show in the block.
119
120	Content type settings:
121
122	- Content Type: The nodes of the content type to be used as content of dynamic display
123	block.
124
125	- Node: The node to show in the Dynamic display block.
126
127	Content container settings:
128
129	- Content container: Container of the content to show, eg. img, to show images.
130
131	- Height: Height of the content to show.
132
133	- Width: Width of the content to show.
134
135	Image settings:
136
137	- Height: Height of the image to show.
138
139	- Width: Width of the image to show.
140
141	Settings:
142
143	- Transition Effect: The transition effect between content.
144
145	- Speed: Speed of the transitions (1000 = 1 second).
146
147	- Timeout: The time (in Milliseconds) between transitions (1000 = 1 second, 0 to
148	disable auto advance).
149
150	- Sort Order: The display order of the content.
151
152	- Pause: Enable users to pause the cycle by hovering on the content.
153
154	- Next: Enable users to advanced to the next content by clicking on the content.
155
156	- Pager: Add a number pager or an image pager to a dynamic display block.
157	You can only add a image pager if your use images from an image folder.
158
159	- Pager_height: Height of the pager.
160
161	- Pager_width: Width of the pager.
162
163	Custom Settings:
164
165	- Custom Options: Add or override custom options for the cycle plug-in.
166	The settings transition effect, container and pager from
167	the settings are used, but can be overriden.
168
169	ADVANCED SLIDESHOWS
170	-------------------
171	See the Advanced slideshow tutorial on http://ddblock.myalbums.biz/node/747 for a
172	tutorial how to make advanced slideshows.
173
174	TROUBLESHOOTING
175	---------------
176	* If a dynamic display block is not displayed, check the following steps:
177
178	- Is the 'view dynamic display blocks' permission enabled?
179	- Did you put the block in one of the regions?
180
181	Also have a look in the FAQ
182
183
184	FAQ
185	---
186	For Frequently Asked Questions - http://ddblock.myalbums.biz/faq
187
188
189	CONTACT
190	-------
191	Original idea cycle module by roopletheme - http://drupal.org/user/164625
192
193	Major rewrite by current Maintainers:
194	* Philip Blaauw (ppblaauw) - http://drupal.org/user/155138
195	* Iren T. Biasong (iren_cruz) - http://drupal.org/user/305000
196
197	We also offer installation, development, theming, customization.
198	You can contact us via the contact form on http://ddblock.myalbums.biz.
199	or via email to ppblaauw (at) gmail.com