function lightbox2_filter_tips in Lightbox2 6
Same name and namespace in other branches
- 5.2 lightbox2.module \lightbox2_filter_tips()
- 5 lightbox2.module \lightbox2_filter_tips()
Implementation of hook_filter_tips().
File
- ./
lightbox2.module, line 276 - Enables the use of lightbox2 which places images above your current page, not within. This frees you from the constraints of the layout, particularly column widths.
Code
function lightbox2_filter_tips($delta, $format, $long = FALSE) {
if ($delta == 0) {
if (!$long) {
return t('Image links with \'rel="lightbox"\' in the <a> tag will appear in a Lightbox when clicked on.');
}
else {
$output = '<p>' . t('To add a lightbox to your images, add rel="lightbox" attribute to any link tag to activate the lightbox. For example:') . '</p>';
$output .= '<p>' . t('<code><a href="image-1.jpg" rel="lightbox">image #1</a></code>') . '</p>';
$output .= '<p>' . t('<code><a href="image-1.jpg" rel="lightbox[][my caption]">image #1</a></code>') . '</p>';
$output .= '<p>' . t('To show a caption either use the title attribute or put in the second set of square brackets of the rel attribute.') . '</p>';
$output .= '<p>' . t('If you have a set of related images that you would like to group, then you will need to include a group name between square brackets in the rel attribute. For example:') . '</p>';
$output .= '<p>' . t('<code><a href="image-1.jpg" rel="lightbox[roadtrip]">image #1</a><br /> <a href="image-2.jpg" rel="lightbox[roadtrip][caption 2]">image #2</a><br /> <a href="image-3.jpg" rel="lightbox[roadtrip][caption 3]">image #3</a><br /> </code>') . '</p>';
$output .= '<p>' . t('There are no limits to the number of image sets per page or how many images are allowed in each set.') . '</p>';
$output .= '<p>' . t('If you wish to turn the caption into a link, format your caption in the following way:') . '</p>';
$output .= '<p>' . t('<code><a href="image-1.jpg" rel=\'lightbox[][<a href="http://www.yourlink.com">View Image Details</a>]\' >image #1</a></code>') . '</p>';
return $output;
}
}
elseif ($delta == 1) {
return t('Image links from G2 are formatted for use with Lightbox2');
}
elseif ($delta == 2) {
if (!$long) {
return t('Image links with \'rel="lightshow"\' in the <a> tag will appear in a Lightbox slideshow when clicked on.');
}
else {
$output = '<p>' . t('To add a lightbox slideshow to your images, add rel="lightshow[slideshowname][slide caption]" attribute to any link tag to activate the slideshow. For example:') . '</p>';
$output .= '<p>' . t('<code><a href="image-1.jpg" rel="lightshow[show1]">image #1</a><br /> <a href="image-2.jpg" rel="lightshow[show1]">image #2</a><br /> <a href="image-3.jpg" rel="lightshow[show1]">image #3</a><br /> </code>') . '</p>';
$output .= '<p>' . t('The title attribute in the link tag is optional. The addition of this attribute enables the display of a caption with the image displayed in the lightbox.') . '</p>';
$output .= '<p>' . t('There are no limits to the number of slideshow image sets per page or how many images are allowed in each slideshow.') . '</p>';
$output .= '<p>' . t('If you wish to turn the caption into a link, format your caption in the following way:') . '</p>';
$output .= '<p>' . t('<code><a href="image-1.jpg" rel=\'lightshow[show1][<a href="http://www.yourlink.com">View Image Details</a>]\'>image #1</a></code>') . '</p>';
return $output;
}
}
elseif ($delta == 3) {
if (!$long) {
return t('Links to HTML content with \'rel="lightframe"\' in the <a> tag will appear in a Lightbox when clicked on.');
}
else {
$output = '<p>' . t('It\'s possible to show webpage content in the lightbox, using iframes. In this case the "rel" attribute should be set to "lightframe". Again it\'s possible to group the content, (e.g. <code>lightframe[search][caption]</code>) but in addition to that, it\'s possible to control some of the iframe properties. It\'s possible to set the "width", "height" and "scrolling" properties of the iframe. The properties are separated from the group name by a <code>|</code>, for example <code>lightframe[search|width:100px;][caption]</code>. If no grouping is being used, then the <code>|</code> is still used and the format would be <code>lightframe[|width:100px;]</code>. The properties should all be of the format "property: value;" - note the closing semi-colon. If no iframe properties are set, then the default width and height of 400px will be used. See below for more detailed examples.') . '</p>';
$output .= '<p>' . t('Basic example:') . '<br />';
$output .= t('<code><a href="http://www.google.com" rel="lightframe">Search google</a></code>') . '</p>';
$output .= '<p>' . t('Grouped example:') . '<br />';
$output .= t('<code><a href="http://www.google.com" rel="lightframe[search][caption]">Search google</a><br /><a href="http://www.yahoo.com" rel="lightframe[search]">Search yahoo</a></code>') . '</p>';
$output .= '<p>' . t('Controlling iframe property example:') . '<br />';
$output .= t('<code><a href="http://www.google.com" rel="lightframe[|width:400px; height:300px; scrolling: auto;][caption]">Search google</a></code>') . '</p>';
$output .= '<p>' . t('Controlling iframe property when grouped example:') . '<br />';
$output .= t('<code><a href="http://www.google.com" rel="lightframe[search|width:400px; height:300px; scrolling: auto;]">Search google</a><br /><a href="http://www.yahoo.com" rel="lightframe[search|width:400px; height:300px;]">Search yahoo</a></code>') . '</p>';
return $output;
}
}
elseif ($delta == 4) {
if (!$long) {
return t('Links to video content with \'rel="lightvideo"\' in the <a> tag will appear in a Lightbox when clicked on.');
}
else {
$output = '<p>' . t('It\'s possible to show video content in the lightbox. In this case the "rel" attribute should be set to <code>lightvideo</code>. It\'s possible to group videos and to control the size of the lightbox by setting the "width" and "height" properties. The properties can be configured like <code>lightvideo[group|width:300px; height: 200px;][caption]</code>. The properties should all be of the format "property: value;" - note the closing semi-colon. If no properties are set, then the default width and height of 400px will be used. See below for more detailed examples.') . '</p>';
$output .= '<p>' . t('Basic example:') . '<br />';
$output .= t('<code><a href="http://video.google.com/videoplay?docid=1811233136844420765" rel="lightvideo">Google video example - default size</a></code>') . '</p>';
$output .= '<p>' . t('Controlling lightbox size example:') . '<br />';
$output .= t('<code><a href="http://video.google.com/videoplay?docid=1811233136844420765" rel="lightvideo[group|width:400px; height:300px;][caption]">Google video example - custom size</a></code>') . '</p>';
$output .= '<p>' . t('Supported video formats include asx, wmv, mov and swf. A number of online video providers are also supported, including YouTube and Google Video. For a full list of the current supported video providers please see the documentation on drupal.org.') . '</p>';
return $output;
}
}
elseif ($delta == 5) {
if (!$long) {
return t('Links to inline or modal content with \'rel="lightmodal"\' in the <a> tag will appear in a Lightbox when clicked on.');
}
else {
$output = '<p>' . t('It\'s possible to show HTML snippets in the lightbox, that is on the same domain. In this case the "rel" attribute should be set to "lightmodal". Again it\'s possible to group the content, (e.g. <code>lightmodal[group][caption]</code>) but in addition to that, it\'s possible to control some of the modal properties. It\'s possible to set the "width", "height" and "scrolling" properties of the modal. The properties are separated from the group name by a <code>|</code>, for example <code>lightmodal[group|width:100px;][caption]</code>. If no grouping is being used, then the <code>|</code> is still used and the format would be <code>lightmodal[|width:100px;]</code>. The properties should all be of the format "property: value;" - note the closing semi-colon. If no modal properties are set, then the default width and height of 400px will be used. See below for more detailed examples.') . '</p>';
$output .= '<p>' . t('Basic example:') . '<br />';
$output .= t('<code><a href="search.php" rel="lightmodal">Search</a></code>') . '</p>';
$output .= '<p>' . t('Grouped example:') . '<br />';
$output .= t('<code><a href="search.php" rel="lightmodal[search][caption 1]">Search</a><br /><a href="search.php?status=1" rel="lightmodal[search]">Search published</a></code>') . '</p>';
$output .= '<p>' . t('Controlling modal property example:') . '<br />';
$output .= t('<code><a href="search.php" rel="lightmodal[|width:400px; height:300px; scrolling: auto;][caption]">Search</a></code>') . '</p>';
$output .= '<p>' . t('Controlling modal property when grouped example:') . '<br />';
$output .= t('<code><a href="search.php" rel="lightmodal[search|width:400px; height:300px; scrolling: auto;]">Search</a><br /><a href="search.php?status=1" rel="lightmodal[search|width:400px; height:300px;]">Search published</a></code>') . '</p>';
return $output;
}
}
}