You are here

Home » API reference » PhotoSwipe 6

README.txt in PhotoSwipe 6

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 8 README.txt
  3. 7.2 README.txt
  4. 7 README.txt
  5. 3.x README.txt
DESCRIPTION 
===========

jQuery-based lightbox library offers very nice mobile browsing features (in
particular swiping to the next picture)!

The module features imagecache and imagefield integration (from the Shadowbox
module).


INSTALLATION 
============

1. Download and install the "Libraries API" module: uncompress the "libraries"
folder, copy it to your "modules" directory, and enable it under Administer >>
Site building >> Modules.
http://drupal.org/project/libraries

2. Place the "photoswipe" folder in your "modules" directory (e.g.
sites/all/modules/photoswipe).

3. Install third party PhotoSwipe software
     Download PhotoSwipe 2.0.0 source from PhotoSwipe website 
     (e.g. http://github.com/downloads/codecomputerlove/PhotoSwipe/code.photoswipe-2.0.0.zip)
     Unarchive it into your "libraries" directory (e.g. sites/all/libraries).
     You may need to create the "libraries" directory first.
     Rename it to "photoswipe" (lower case).
NB: Relying on libraries module to locate 'photoswipe' folder allows you to place
it in a site specific (e.g. sites/mysite/libraries) or default folder
(e.g. sites/all/libraries). Site-specific versions are selected preferentially.

4. Enable the PhotoSwipe module under Administer >> Site building >> Modules.


USAGE
=====

In order to use this module, you must install and activate ImageCache and 
ImageField modules.
After adding an imagefield to any content type (e.g. 'album'), you can select
'PhotoSwipe: Preset1 to Preset2' as a display mode in Administer >> Content
management >> MyContentType in the tab 'Display fields'. All possible
combinations of imagecache presets (as thumbnails and link targets) are proposed.


ADVANCED CONFIGURATION
======================

You can pass a javascript string to override the default option of Photoswipe
(documented in the file README.md of PhotoSwipe).

If you want better desktop browser compatibility, you can choose to load
PhotoSwipe using jQuery.
Warning: Since this module is based on a much newer version of jQuery (even than
the one proposed by jQuery Update), it is likely to create heavy compatibility
problems with other modules and cannot be used in admin or edit pages.
Nonetheless it can be used without Drupal or jQuery errors on standard pages!


AUTHOR 
======

Module written by Thomas Julou. http://drupal.org/user/273952
ImageCache and ImageField integration taken from Shadowbox module.

PhotoSwipe http://www.photoswipe.org/


TO DO 
=====

Add javascript config string in settings.
?Does not disable admin by default if standard ps is used?

Drush integration

Port to 7.x


CHANGE LOG 
==========

File

README.txt
View source 
  1. DESCRIPTION 

  2. ===========

  3. 

  4. jQuery-based lightbox library offers very nice mobile browsing features (in

  5. particular swiping to the next picture)!

  6. 

  7. The module features imagecache and imagefield integration (from the Shadowbox

  8. module).

  9. 

  10. 

  11. INSTALLATION 

  12. ============

  13. 

  14. 1. Download and install the "Libraries API" module: uncompress the "libraries"

  15. folder, copy it to your "modules" directory, and enable it under Administer >>

  16. Site building >> Modules.

  17. http://drupal.org/project/libraries

  18. 

  19. 2. Place the "photoswipe" folder in your "modules" directory (e.g.

  20. sites/all/modules/photoswipe).

  21. 

  22. 3. Install third party PhotoSwipe software

  23.      Download PhotoSwipe 2.0.0 source from PhotoSwipe website 

  24.      (e.g. http://github.com/downloads/codecomputerlove/PhotoSwipe/code.photoswipe-2.0.0.zip)

  25.      Unarchive it into your "libraries" directory (e.g. sites/all/libraries).

  26.      You may need to create the "libraries" directory first.

  27.      Rename it to "photoswipe" (lower case).

  28. NB: Relying on libraries module to locate 'photoswipe' folder allows you to place

  29. it in a site specific (e.g. sites/mysite/libraries) or default folder

  30. (e.g. sites/all/libraries). Site-specific versions are selected preferentially.

  31. 

  32. 4. Enable the PhotoSwipe module under Administer >> Site building >> Modules.

  33. 

  34. 

  35. USAGE

  36. =====

  37. 

  38. In order to use this module, you must install and activate ImageCache and 

  39. ImageField modules.

  40. After adding an imagefield to any content type (e.g. 'album'), you can select

  41. 'PhotoSwipe: Preset1 to Preset2' as a display mode in Administer >> Content

  42. management >> MyContentType in the tab 'Display fields'. All possible

  43. combinations of imagecache presets (as thumbnails and link targets) are proposed.

  44. 

  45. 

  46. ADVANCED CONFIGURATION

  47. ======================

  48. 

  49. You can pass a javascript string to override the default option of Photoswipe

  50. (documented in the file README.md of PhotoSwipe).

  51. 

  52. If you want better desktop browser compatibility, you can choose to load

  53. PhotoSwipe using jQuery.

  54. Warning: Since this module is based on a much newer version of jQuery (even than

  55. the one proposed by jQuery Update), it is likely to create heavy compatibility

  56. problems with other modules and cannot be used in admin or edit pages.

  57. Nonetheless it can be used without Drupal or jQuery errors on standard pages!

  58. 

  59. 

  60. AUTHOR 

  61. ======

  62. 

  63. Module written by Thomas Julou. http://drupal.org/user/273952

  64. ImageCache and ImageField integration taken from Shadowbox module.

  65. 

  66. PhotoSwipe http://www.photoswipe.org/

  67. 

  68. 

  69. TO DO 

  70. =====

  71. 

  72. Add javascript config string in settings.

  73. ?Does not disable admin by default if standard ps is used?

  74. 

  75. Drush integration

  76. 

  77. Port to 7.x

  78. 

  79. 

  80. CHANGE LOG 

  81. ==========

  82.