You are here

Home » API reference » Bootstrap - Photo Gallery 7.3

README.txt in Bootstrap - Photo Gallery 7.3 

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Installation & Usage
 * Overriding Templates
 * Credits

INTRODUCTION
------------

Bootstrap Gallery is a views plugin that creates appealing Photo Galleries from any content type.

Features:
    - Content type independent. It doesn't require it's own content type.
    - Displays images in a responsive grid format.
    - Provides different options for controlling gallery Modal and Lightbox
    - Easily themed and overridden.
    - Contains a sample Gallery feature that would save you some effort in node and view creation. However, you still need to do steps 7-9 in the usage section.


INSTALLATION & USAGE
--------------------

Bootstrap Gallery has few dependencies. You obviously need to have bootstrap library installed,
whether through Bootstrap Theme, or Bootstrap API module in order for the gallery to be displayed correctly.

Views, and (Preferably) Views UI need to be installed. So that the Views plugin can be functional.

JQuery Update module is required, which would include a newer version of JQuery to Drupal. jQuery 1.8 is recommended.

1. Download module, extract and copy "bootstrap_gallery" directory to your sites/SITENAME/modules directory.

3. Enable the module from the Admin > Modules page.

4. Create a view from Admin > Structure > Views page.

5. In the Format section, click on Show and Select "Fields" option.

6. In the Fields section, add the Image field and an optional title field; so that both can be used in the gallery.

7. In the Format section again, click on Format and select "Bootstrap Gallery" as the view display format.

8. In Bootstrap Gallery settings, specify the image field to be used and title field that will be used as an Image Caption.

9. Save view.


OVERRIDING TEMPLATES
--------------------

Bootstrap Gallery output can be controlled easily by overriding the template files included in the "theme" folder.
Which exists in the same module directory. The theme folder contains the following files:

1. views-view-bootstrap-gallery.tpl.php : A normal Views template file contains the HTML for the gallery grid.
2. bootstrap-gallery-item.tpl.php : Template file for a single gallery item.
3. bootstrap-gallery-modal.tpl.php : Template file for the gallery Modal.

To override any of these files, simply copy to your default theme directory and modify HTML as desired.


CREDITS
-------

This module is bundled with couple of Javascript libraries that were developed by:

Sebastian Tschan
https://blueimp.net

Javascript libraries has been shaped and modified to integrate with this module for Drupal use by:

Ahmad Kharbat
http://kharbat.me

File

README.txt
View source 
  1. 

  2. CONTENTS OF THIS FILE

  3. ---------------------

  4. 

  5.  * Introduction

  6.  * Installation & Usage

  7.  * Overriding Templates

  8.  * Credits

  9. 

  10. INTRODUCTION

  11. ------------

  12. 

  13. Bootstrap Gallery is a views plugin that creates appealing Photo Galleries from any content type.

  14. 

  15. Features:

  16.     - Content type independent. It doesn't require it's own content type.

  17.     - Displays images in a responsive grid format.

  18.     - Provides different options for controlling gallery Modal and Lightbox

  19.     - Easily themed and overridden.

  20.     - Contains a sample Gallery feature that would save you some effort in node and view creation. However, you still need to do steps 7-9 in the usage section.

  21. 

  22. 

  23. INSTALLATION & USAGE

  24. --------------------

  25. 

  26. Bootstrap Gallery has few dependencies. You obviously need to have bootstrap library installed,

  27. whether through Bootstrap Theme, or Bootstrap API module in order for the gallery to be displayed correctly.

  28. 

  29. Views, and (Preferably) Views UI need to be installed. So that the Views plugin can be functional.

  30. 

  31. JQuery Update module is required, which would include a newer version of JQuery to Drupal. jQuery 1.8 is recommended.

  32. 

  33. 1. Download module, extract and copy "bootstrap_gallery" directory to your sites/SITENAME/modules directory.

  34. 

  35. 3. Enable the module from the Admin > Modules page.

  36. 

  37. 4. Create a view from Admin > Structure > Views page.

  38. 

  39. 5. In the Format section, click on Show and Select "Fields" option.

  40. 

  41. 6. In the Fields section, add the Image field and an optional title field; so that both can be used in the gallery.

  42. 

  43. 7. In the Format section again, click on Format and select "Bootstrap Gallery" as the view display format.

  44. 

  45. 8. In Bootstrap Gallery settings, specify the image field to be used and title field that will be used as an Image Caption.

  46. 

  47. 9. Save view.

  48. 

  49. 

  50. OVERRIDING TEMPLATES

  51. --------------------

  52. 

  53. Bootstrap Gallery output can be controlled easily by overriding the template files included in the "theme" folder.

  54. Which exists in the same module directory. The theme folder contains the following files:

  55. 

  56. 1. views-view-bootstrap-gallery.tpl.php : A normal Views template file contains the HTML for the gallery grid.

  57. 2. bootstrap-gallery-item.tpl.php : Template file for a single gallery item.

  58. 3. bootstrap-gallery-modal.tpl.php : Template file for the gallery Modal.

  59. 

  60. To override any of these files, simply copy to your default theme directory and modify HTML as desired.

  61. 

  62. 

  63. CREDITS

  64. -------

  65. 

  66. This module is bundled with couple of Javascript libraries that were developed by:

  67. 

  68. Sebastian Tschan

  69. https://blueimp.net

  70. 

  71. Javascript libraries has been shaped and modified to integrate with this module for Drupal use by:

  72. 

  73. Ahmad Kharbat

  74. http://kharbat.me

  75.