DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:prettyphoto

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:prettyphoto [2013-05-31 08:52] – new prettyPghoto version 89.183.29.127plugin:prettyphoto [2022-09-15 18:43] (current) 204.220.23.60
Line 3: Line 3:
 ---- plugin ---- ---- plugin ----
 description: Adds prettyPhoto support for images description: Adds prettyPhoto support for images
-author     : Marcus von Appen +author     : lpaulsen93 (previous author: Marcus von Appen) 
-email      : marcus@sysfault.org+email      : #
 type       : renderer type       : renderer
-lastupdate : 2013-05-31 +lastupdate : 2020-10-03 
-compatible : Weatherwax+compatible : Weatherwax, Detritus, Hogfather
 depends    :  depends    : 
 conflicts  conflicts 
Line 13: Line 13:
 tags       : media, images, ajax, javascript prettyphoto, popup, lightbox, gallery tags       : media, images, ajax, javascript prettyphoto, popup, lightbox, gallery
  
-downloadurl: https://bitbucket.org/marcusva/dokuwiki-plugin-prettyphoto/downloads/dokuwiki-prettyphoto-2013-05-31.zip +downloadurl: https://github.com/lpaulsen93/dw-plugin-prettyPhoto/archive/master.zip 
-bugtracker : https://bitbucket.org/marcusva/dokuwiki-plugin-prettyphoto/issues +bugtracker : https://github.com/lpaulsen93/dw-plugin-prettyPhoto/issues 
-sourcerepo : https://bitbucket.org/marcusva/dokuwiki-plugin-prettyphoto+sourcerepo : https://github.com/lpaulsen93/dw-plugin-prettyPhoto
  
 screenshot_img :  screenshot_img : 
 ---- ----
 +
 +The plugin will automatically create [[http://www.no-margin-for-errors.com/projects/prettyphoto-jquery-lightbox-clone/|prettyPhoto]] popup links for all images that are embedded as direct links.
 +
 +You can find a simple showcase at http://sysfault.org/dokuwiki/projects:dwpretty FIXME
  
 ===== Installation ===== ===== Installation =====
  
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 ===== Examples/Usage ===== ===== Examples/Usage =====
  
-The plugin will automatically create [[http://www.no-margin-for-errors.com/projects/prettyphoto-jquery-lightbox-clone/|prettyPhoto]] popup links for all images that are direct links +The default configuration of the plugin will provide a overlay box for 
-  {{wiki:dokuwiki-128.png?direct|Image Description}}+images that are linked directly into the page:
  
-You also can use the [[devel:renderer_plugins|renderer]] of the plugin to enable the popup for +  {{fancyimage.jpg?direct&100|}} 
-images that usually would refer to the details pageImages with the 'nolink' or 'linkonly' parameter + 
-are not affected.+The plugin is comes with an own renderer that automatically replaces 
 +internal image media links, which refer to the details page of the 
 +images, with direct links to the images. This is a convenience mechanism 
 +to save you typing "?direct" for each and every image link. See 
 +[[doku>images]] for further details about image links. 
 + 
 +Using '?direct' as [[doku>images|image]] parameter will cause the plugin to create lightbox-like overlays. 
 + 
 +  {{:projects:pumpkins.jpg?direct&100|}} 
 +  {{:projects:cupcakes_shelf.jpg?direct&100|}} 
 + 
 +'?nolink' will not cause the plugin to create any overlay. The default behaviour is preserved. 
 + 
 +  {{:projects:pumpkins.jpg?nolink&100|}} 
 +  {{:projects:cupcakes_shelf.jpg?nolink&100|}} 
 + 
 + 
 +'?linkonly' will not cause the plugin to create any overlayThe default behaviour is preserved. 
 + 
 +  {{:projects:pumpkins.jpg?linkonly&100|}} 
 +  {{:projects:cupcakes_shelf.jpg?linkonly&100|}} 
 + 
 + 
 +If you do not want to rework all your image links, you can also enable the custom renderer that ships with the plugin. It will pick all images that do not use the 'nolink' or 'linkonly' parameter and create an overlay. 
 + 
 +  {{:projects:pumpkins.jpg?100|}} 
 +  {{:projects:cupcakes_shelf.jpg?100|}} 
 +  
 +===== Customization ===== 
 + 
 +The main magic happens within ''script.js'', which will pull in a configuration file ''prettyphoto.conf.js'', located in DokuWiki's ''conf/'' folder. Two javascript variables will be tested within the configuration file, 
 + 
 +  var PRETTYPHOTO_PLUGIN_MEDIAPATH 
 + 
 +which defines the media item link for the DokuWiki installation. By default, DokuWiki uses ''lib/exe/fetch.php?media='', your installation however might use different links, changed by rewrite rules. If this is the case, you should set 
 + 
 +  var PRETTYPHOTO_PLUGIN_MEDIAPATH = "<your media path>"; 
 + 
 +within ''prettyphoto.conf.js''. To customize the behaviour of the prettyPhoto overlay, you can use 
 + 
 +  var PRETTYPHOTO_PLUGIN_PARAMS 
 + 
 +which contains the prettyPhoto configuration to be used (see the [[http://www.no-margin-for-errors.com/projects/prettyphoto-jquery-lightbox-clone/documentation|prettyPhoto documentation]] for further details on customizing), e.g. 
 + 
 +  var PRETTYPHOTO_PLUGIN_PARAMS = { social_tools: '' }; 
 + 
 +for disabling social media integration.
  
-  {{wiki:dokuwiki-128.png|Image Description}} 
-  {{wiki:dokuwiki-128.png?direct|Image Description}} 
-   
-will create a prettyPhoto popup, while 
-   
-  {{wiki:dokuwiki-128.png?nolink|Image Description}} 
-  {{wiki:dokuwiki-128.png?linkonly|Image Description}} 
-   
-will not create a popup 
-   
 ===== Development ===== ===== Development =====
 +
 +Starting from 4th of October 2020 the plugin is maintained by [[user>lpaulsen93|lpaulsen93]]. It is based on a fork from [[user>s.sahara|s.sahara]] who fixed the Hogfather incompatibility.
  
 === Change Log === === Change Log ===
  
-  * **2013-05-31** +Check the [[https://github.com/lpaulsen93/dw-plugin-prettyPhoto/commits/master|commit log]]: 
-    * fixed a JS compression issue +{{rss>https://github.com/lpaulsen93/dw-plugin-prettyPhoto/commits/master.atom}}
-    * fixed detail links not being picked up with default rewrite rules +
-  * **2013-05-30** +
-    * Initial release+
  
 === Known Bugs and Issues === === Known Bugs and Issues ===
  
-Please post any bugs or issues on the [[https://bitbucket.org/marcusva/dokuwiki-plugin-prettyphoto/issues|bug tracker]]+Please post any bugs or issues on the [[https://github.com/lpaulsen93/dw-plugin-prettyPhoto/issues|bug tracker]]
  
 === Feature requests === === Feature requests ===
  
-Please post feature requests on the [[https://bitbucket.org/marcusva/dokuwiki-plugin-prettyphoto/issues|bug tracker]]+Please post feature requests on the [[https://github.com/lpaulsen93/dw-plugin-prettyPhoto/issues|bug tracker]] 
 + 
 +---- 
 + 
 +:!: Doesn't work with Dokuwiki rewrite mode. FIXME 
 +> What execatly does not work? If you're using .htaccess rewriting, just tweak the paths in the .conf.js file. 
 +>> Having trouble to get the renderer to work with hrun - had a running installation, copied all content, installed prettyphoto afterwards through plugin manager. using htaccess rewrite and no gallery pluginin. the photo gets no lightbox but is opened alone in the tab --~~ 
 +>>> I can confirm that Dokuwiki rewrite crashes this plugin. A working fix ist ready to be pulled, but it seems the author is not updating any more. So you have to merge/update manually with the files from this [[https://bitbucket.org/marcusva/dokuwiki-plugin-prettyphoto/pull-requests|pull-request-link.]] 
 + 
 +> The [[https://github.com/scaron/prettyphoto|prettyPhoto]] v.3.1.6 had released on May 7, 2015 which covers a XSS Fix. There is [[https://github.com/ssahara/dw-plugin-prettyPhoto|a fork]] of "PrettyPhoto Plugin for DokuWiki" that includes updated prettyPhoto v3.1.6 and a patch I sent as [[https://bitbucket.org/marcusva/dokuwiki-plugin-prettyphoto/pull-requests/1/auto-detection-of/diff|PR]] around 2014 (Auto detection of PRETTYPHOTO_PLUGIN_MEDIAPATH based on ''$conf['userewrite']'' setting). it works with DokuWiki Release 2015-08-10a "Detritus". --- [[user>s.sahara|s.sahara]] //2015-10-15 14:27//
  
 +Has this been updated to work with DokuWiki Igor?
  
plugin/prettyphoto.1369983176.txt.gz · Last modified: 2013-05-31 08:52 by 89.183.29.127

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki