function colorbox_help

Same name and namespace in other branches

1. 2.0.x colorbox.module \colorbox_help() 1 comment
2. 8.x-1.x colorbox.module \colorbox_help() 1 comment

Implements hook_help().

File

./colorbox.module, line 576

Code

function colorbox_help($path, $arg) {
    switch ($path) {
        case 'admin/help#colorbox':
            $output = '<h3>' . t('About') . '</h3>';
            $output .= '<p>' . t('<a target="_blank" href="@colorbox_project_link">Colorbox</a> is a light-weight customizable lightbox plugin for jQuery. This module allows for integration of Colorbox into Drupal.', array(
                '@colorbox_project_link' => 'https://www.drupal.org/project/colorbox',
            )) . '</p>';
            $output .= '<p>' . t('Images, iframed or inline content etc. can be displayed in a overlay above the current page.') . '</p>';
            $output .= '<h3>' . t('Usage') . '</h3>';
            $output .= '<p>' . t('Go to "Configuration" » "Media" » "Colorbox" to find all the configuration options.') . '</p>';
            $output .= '<h3>' . t('Features') . '</h3>';
            $output .= '<b>' . t('The Colorbox:') . '</b>';
            $output .= '<ul>';
            $output .= '<li>' . t('Excellent integration with Image field and Image styles') . '</li>';
            $output .= '<li>' . t('Choose between a default style and 5 example styles that are included.') . '</li>';
            $output .= '<li>' . t('Style the Colorbox with a custom colorbox.css file in your theme.') . '</li>';
            $output .= '<li>' . t('Drush command to download and install the Colorbox plugin in sites/all/libraries') . '</li>';
            $output .= '</ul>';
            $output .= '<b>' . t('The Colorbox plugin:') . '</b>';
            $output .= '<ul>';
            $output .= '<li>' . t('Supports photos, grouping, slideshow, ajax, inline, and iframed content.') . '</li>';
            $output .= '<li>' . t('Appearance is controlled through CSS so it can be restyled.') . '</li>';
            $output .= '<li>' . t('Preloads upcoming images in a photo group.') . '</li>';
            $output .= '<li>' . t('Completely unobtrusive, options are set in the JS and require no') . '</li>';
            $output .= '<li>' . t('changes to existing HTML.') . '</li>';
            $output .= '<li>' . t('Compatible with: jQuery 1.3.2+ in Firefox, Safari, Chrome, Opera,') . '</li>';
            $output .= '<li>' . t('Internet Explorer 7+.') . '</li>';
            $output .= '<li>' . t('Released under the MIT License.') . '</p>';
            $output .= '</ul>';
            $output .= '<h3>' . t('Colorbox screencasts') . '</h3>';
            $output .= '<b>' . t('Part 1 to 3 is for an older 7.x-1.x version of the Colorbox:') . '</b>';
            $output .= '<ul>';
            $output .= '<li>' . t('Part 1: <a href="@colorbox_screencasts_part1" target="blank">Installation and image field integration on Vimeo</a>', array(
                '@colorbox_screencasts_part1' => 'https://vimeo.com/19122850',
            )) . '</li>';
            $output .= '<li>' . t('Part 2: <a href="@colorbox_screencasts_part2" target="blank">Inline images with the Insert module on Vimeo</a>', array(
                '@colorbox_screencasts_part2' => 'https://vimeo.com/19386122',
            )) . '</li>';
            $output .= '<li>' . t('Part 3: <a href="@colorbox_screencasts_part3" target="blank">Building a image gallery and a image slideshow.</a>', array(
                '@colorbox_screencasts_part3' => 'https://vimeo.com/26411524',
            )) . '</li>';
            $output .= '</ul>';
            $output .= '<b>' . t('Contributed screencasts:') . '</b>';
            $output .= '<ul>';
            $output .= '<li>' . t('<a href="@colorbox_contributed_screencasts_part1" target="blank">Drupal 7 Colorbox project</a> by Code Karate', array(
                '@colorbox_contributed_screencasts_part1' => 'http://codekarate.com/daily-dose-of-drupal/drupal-7-colorbox-module',
            )) . '</li>';
            $output .= '<li>' . t('<a href="@colorbox_contributed_screencasts_part2" target="blank">Creating and Theming a Node Photo Gallery with Drupal 7 and Colorbox</a> by High Rock Media.', array(
                '@colorbox_contributed_screencasts_part2' => 'http://dannyenglander.com/blog/screencast-creating-and-theming-node-photo-gallery-drupal-7-and-colorbox',
            )) . '</li>';
            $output .= '<li>' . t('<a href="@colorbox_contributed_screencasts_part3" target="blank">How to Build a Lightbox Portfolio in Drupal 7</a> by CMS Quickstart', array(
                '@colorbox_contributed_screencasts_part3' => 'http://www.cmsquickstart.com/blog/tutorial-how-build-lightbox-portfolio-drupal-7',
            )) . '</li>';
            $output .= '</ul>';
            $output .= '<h3>' . t('Load Content in a Colorbox') . '</h3>';
            $output .= '<p>' . t('Check the "Enable Colorbox load" option in Colorbox settings.') . '</p>';
            $output .= '<p>' . t('This enables custom links that can open content in a Colorbox.') . '</p>';
            $output .= '<p>' . t('Add the class "colorbox-load" to the link and build the url like this "[path]?width=500&height=500&iframe=true" or "[path]?width=500&height=500" if you don\'t want an iframe.') . '</p>';
            $output .= '<p>' . t('Other projects may activate this for easy Colorbox integration.') . '</p>';
            $output .= '<h3>' . t('Load Images from custom links in a Colorbox') . '</h3>';
            $output .= '<p>' . t('Add the class "colorbox" to the link and point its href attribute to the image you want to display in the Colorbox.') . '</p>';
            return $output;
    }
}