| 1 |
$Id$
|
| 2 |
|
| 3 |
What
|
| 4 |
----
|
| 5 |
The PicLens module for Drupal makes it easy for you to provide your visitors
|
| 6 |
with an immersive slideshow experience for rich media on your website. It supports
|
| 7 |
the media RSS feeds which is needed by the 3D plugins. The PicLens Lite is also supported
|
| 8 |
enabling a really slick slideshow on your own website.
|
| 9 |
|
| 10 |
See the PicLens Lite in action on http://realize.be/image-galleries/drupalcon-boston-2008
|
| 11 |
|
| 12 |
For more information about PicLens and browser 3D plugins, go to http://www.piclens.com/
|
| 13 |
|
| 14 |
Supported Modules
|
| 15 |
-----------------
|
| 16 |
The image gallery module is supported out of the box. It automatically creates a media rss feed
|
| 17 |
listing all images in an image gallery. It can also add a 'Start slideshow' link on image
|
| 18 |
gallery pages to start PicLens Lite, a really slick slideshow interface.
|
| 19 |
Go to http://expample.com/admin/settings/piclens for settings.
|
| 20 |
|
| 21 |
API
|
| 22 |
---
|
| 23 |
Several functions are available to create your own PicLens rss feed.
|
| 24 |
|
| 25 |
* piclens_feed_url($url, $title);
|
| 26 |
This function adds the rss feed with the $url to your own menu callback providing the feed
|
| 27 |
into the <head> tag of your document. $title is optional.
|
| 28 |
|
| 29 |
* piclens_lite_javascript()
|
| 30 |
This function adds the javascript for the PicLens Lite into content region of your document.
|
| 31 |
|
| 32 |
* piclens_lite_link($drupal_set_message)
|
| 33 |
This function returns a link to start the PicLens Lite slideshow.
|
| 34 |
If $drupal_set_message = TRUE, the link will be inserted as a drupal message, otherwhise
|
| 35 |
the link is simply returned. Inside this function theme('piclens_lite_html_link'); is called
|
| 36 |
to return the html. You can override the theming with phptemplate_piclens_lite_html_link() off course.
|
| 37 |
|
| 38 |
* piclens_format_item($item);
|
| 39 |
This function formats one item (image, video) into a valid xml structure for the piclens feed.
|
| 40 |
$item is an array with following properties:
|
| 41 |
- title : title image or video
|
| 42 |
- link : direct link to content
|
| 43 |
- thumbnail : thumbnail url image or video
|
| 44 |
- content : content url of image or video
|
| 45 |
|
| 46 |
* piclens_rss($items);
|
| 47 |
This function outputs the feed. $items is a string formatted xml list of $items.
|
| 48 |
|
| 49 |
/**
|
| 50 |
* Example menu callback spitting out piclens rss feed with your own items.
|
| 51 |
*/
|
| 52 |
function example_module() {
|
| 53 |
$items = '';
|
| 54 |
// get all my items
|
| 55 |
$my_items = db_query("SELECT * FROM {my_table}");
|
| 56 |
while ($my_item = db_fetch_object($my_items)) {
|
| 57 |
$item = array(
|
| 58 |
'title' => $my_item->title,
|
| 59 |
'link' => $my_item->link,
|
| 60 |
'thumbnail' => $my_item->thumbnail,
|
| 61 |
'content' => $my_item->content,
|
| 62 |
);
|
| 63 |
$items .= piclens_format_item($item);
|
| 64 |
}
|
| 65 |
// output rss feed. Exit is not needed, piclens_rss sets the appropiate header.
|
| 66 |
piclens_rss($items);
|
| 67 |
}
|
| 68 |
|
| 69 |
Bug reports, feature requests etc
|
| 70 |
---------------------------------
|
| 71 |
http://drupal.org/project/piclens
|
Parent Directory
| 
Revision Log
| 
Revision Graph