Works with MODx Version(s): 0.9.5
Submitted: Nov 17th 2006 | License: GPL - GNU Public | Downloads: 1572
This resource has been deprecated.

Description

Changes to the parameters (compared to 0.4.1)

Removed:

• display_manage - if you don't want "manage pictures" to show, make a custom template and don't put it's placeholder to the template
• use_charset - htmlentities conversion is not done in the snippet code anymore, templates uses phx to convert picture titles/descriptions to htmlentities. Slidebox xml uses the charset setting from modx.
• only_page_numbers - if you don't want next / prev links, don't put their placeholders in your template
• childgalleries_title_field - in child gallery template, there are placeholders for every modx document object field

Meaning Changed

• pics_per_row (was "pics_in_a_row" before) - as the gallery over view is not built in to a table anymore (unless you make it so ;D), there are many ways to define how many pictures will be in a row. You can either set the max width in css of the div that contains the pictures or use this parameter. By setting this to 3 for example will result that after every 3 images in gallery overview, the contents of clearerTpl is outputted to the page. In default templates that template has br tag that has clear:both set in it.

New parameters:

• &debug - Shows some debug information (feature not fully implemented yet). Possible values [ 0 | 1 ].
• &lang - Sets the gallery language via parameter. Language files not fully updated yet. Possible values [ en | fr | es | fi | addyourown ].
• &view_gallery - Shows a gallery from some other document. Possible values [ document id ].
• &manageOuterTpl - The outer template for gallery management. Possible values [ path to a file | chunk name | or template content as string ].
• &managePictureTpl - The template for single picture element in the gallery management. Possible values [ path to a file | chunk name | or template content as string ].
• &manageUploadTpl - The template for the file upload rows in gallery management. Possible values [ path to a file | chunk name | or template content as string ].
• &galleryOuterTpl - The outer template for the gallery overview. Possible values [ path to a file | chunk name | or template content as string ].
• &galleryPictureTpl - The template for single picture element in the gallery overview. Possible values [ path to a file | chunk name | or template content as string ].
• &childgalleryPictureTpl - The template for single child gallery element in the gallery overview. Possible values [ path to a file | chunk name | or template content as string ].
• &pictureTpl - The template for the picture view. Possible values [ path to a file | chunk name | or template content as string ].
• &clearerTpl - The template to use when using &pics_per_row parameter as a row clearer
• &pageNumberTpl - The template for page numbers in gallery overview
• &css - css styles to add to the page head. Possible values [ path to a file (will be added as css link to the html source) | chunk name (use <style..></style> tags in the chunk) | or css content as string (use <style..></style> tags) ].
• &js - extra javascript to be added to the page head. Possible values [ path to a file (will be added as js link to the html source) | chunk name (use <script..></script> tags in the chunk) | or css content as string (use <script..></script> tags) ].
• &slideshow_mode - Display mode for the slide show. Possible values [ timed | showcase ].
• &slideshow_width - Width for the slideshow div. Overflow will be hidden, so this should be the max width for biggest picture (&max_pic_size).
• &slideshow_height - Height for the slideshow div. Overflow will be hidden, so this should be the max height for biggest picture (&max_pic_size).
• &slideshow_slidedelay - Delay between timed mode slide change in milliseconds. Default: 9000
• &slideshow_blendduration - Duration of the blend effect between slide change in milliseconds. Default: 400
• &slideshow_showinfo - Will the picture info, eg. title and description be shown? Possible values 1 | 0. Defalt: 1
• &slideshow_infodelay - Delay to setting the info box visible / hidden. This has to be slideshow_slidedelay / 2 or smaller.
  This also effects the delay of showcase mode slide change. Default: 500

New values for parameters:

• &embedtype - New possible values [ slidebox | lightboxv2 | slimbox | slideshow | popup | external ].

Available placeholders

manageOuterTpl
Look for the default content in: assets/snippets/maxigallery/templates/manageoutertpl.html

[+maxigallery.messages+] = Error messages / notices in the picture management (that comes from the language file).
[+maxigallery.urlback+] = Url to the "back to normal view" link
[+maxigallery.urlaction+] = Form action url
[+maxigallery.managepictures+] = the pictures (content from managePictureTpl)
[+maxigallery.uploadpictures+] = the picture upload fields (content from manageUploadTpl)
[+maxigallery.hiddenfields+] = hidden fields for the picture management form that needs to be in it
[+maxigallery.pageinfo.fieldname+] = MODx document object fields from the gallery document where. The "fieldname" would be pagetitle, longtitle, pub_date, etc..
[+maxigallery.strings.keyname+] = Texts from the MaxiGallery language file. The "keyname" would be click_to_zoom, previous, next, etc..

managePictureTpl
Look for the default content in: assets/snippets/maxigallery/templates/managepicturetpl.html

[+maxigallery.picture.fieldname+] = Content from MaxiGallery picture fields. The "fieldname" can be id, gal_id, filename, title, date, descr, pos or own_id.
[+maxigallery.path_to_gal+] = the path where the current gallery images are. eg. assets/galleries/120/
[+maxigallery.fieldnames.field+] = The names for the form input fields. The "field" can be delete, position, title, pictureid, modified and description. Look a the default template how these are used.
[+maxigallery.strings.keyname+] = Texts from the MaxiGallery language file. The "keyname" would be click_to_zoom, previous, next, etc..

manageUploadTpl
Look for the default content in: assets/snippets/maxigallery/templates/manageuploadtpl.html

[+maxigallery.counter+] = Number for the current row
[+maxigallery.fieldnames.file+] = Name for the form input field

galleryOuterTpl
Look for the default content in: assets/snippets/maxigallery/templates/galleryoutertpl.html

[+maxigallery.embedtype+] = MaxiGallery embedtype configuration setting value
[+maxigallery.managebutton+] = Button for the picture management
[+maxigallery.childgalleries+] = Child galleries (content from childgalleryPictureTpl)
[+maxigallery.pagenumber+] = Current page number
[+maxigallery.pagecount+] = Total number of pages
[+maxigallery.previous_page_url+] = Url for the previous page link
[+maxigallery.next_page_url+] = Url for the next page link
[+maxigallery.pagenumbers+] = Page numbers (content from pageNumberTpl)
[+maxigallery.pictures+] = Gallery pictures (content from galleryPictureTpl)
[+maxigallery.pageinfo.fieldname+] = MODx document object fields from the gallery document where. The "fieldname" would be pagetitle, longtitle, pub_date, etc..
[+maxigallery.strings.keyname+] = Texts from the MaxiGallery language file. The "keyname" would be click_to_zoom, previous, next, etc..

galleryPictureTpl
Look for the default content in: assets/snippets/maxigallery/templates/gallerypicturetpl.html

[+maxigallery.embedtype+] = MaxiGallery embedtype configuration setting value
[+maxigallery.picture.fieldname+] = Content from MaxiGallery picture fields. The "fieldname" can be id, gal_id, filename, title, date, descr, pos or own_id.
[+maxigallery.pageinfo.fieldname+] = MODx document object fields from the gallery document where. The "fieldname" would be pagetitle, longtitle, pub_date, etc..
[+maxigallery.path_to_gal+] = the path where the current gallery images are. eg. assets/galleries/120/
[+maxigallery.picture_link_url+] = Url for the link from the picture
[+maxigallery.big_pic_exists+] = Indication that does the big picture exist. 1 for yes, 0 for no.
[+maxigallery.picture_height_big+] = Heigth of the big picture
[+maxigallery.picture_width_big+] = Width of the big picture
[+maxigallery.picture_height_normal+] = Heigth of the normal picture
[+maxigallery.picture_width_normal+] = Width of the normal picture
[+maxigallery.picture_height_thumb+] = Heigth of the thumbnail picture
[+maxigallery.picture_width_thumb+] = Width of the thumbnail picture

childgalleryPictureTpl
Look for the default content in: assets/snippets/maxigallery/templates/childgallerytpl.html

[+maxigallery.pageinfo.fieldname+] = MODx document object fields from the child gallery document where. The "fieldname" would be pagetitle, longtitle, pub_date, etc..
[+maxigallery.strings.keyname+] = Texts from the MaxiGallery language file. The "keyname" would be click_to_zoom, previous, next, etc..
[+maxigallery.picture.fieldname+] = Content from MaxiGallery picture fields (from the first picture in the child gallery). The "fieldname" can be id, gal_id, filename, title, date, descr, pos or own_id.
[+maxigallery.childurl+] = Url to the child gallery document.
[+maxigallery.path_to_gal+] = the path where the current gallery images are. eg. assets/galleries/120/

pictureTpl
Look for the default content in: assets/snippets/maxigallery/templates/picturetpl.html

[+maxigallery.pageinfo.fieldname+] = MODx document object fields from the gallery document where. The "fieldname" would be pagetitle, longtitle, pub_date, etc..
[+maxigallery.strings.keyname+] = Texts from the MaxiGallery language file. The "keyname" would be click_to_zoom, previous, next, etc..
[+maxigallery.big_img_linkstyle+] = MaxiGallery big_img_linkstyle configuration setting value
[+maxigallery.keep_bigimg+] = MaxiGallery keep_bigimg configuration setting value
[+maxigallery.path_to_gal+] = the path where the current gallery images are. eg. assets/galleries/120/
[+maxigallery.picture.fieldname+] = Content from MaxiGallery picture fields. The "fieldname" can be id, gal_id, filename, title, date, descr, pos or own_id.
[+maxigallery.counter+] = Current picture number
[+maxigallery.total_pics_count+] = Total number of pictures in this gallery
[+maxigallery.previous_pic_url+] = Url to the previous picture link
[+maxigallery.next_pic_url+] = Url to the next picture link
[+maxigallery.index_url+] = Url to gallery overview index
[+maxigallery.big_pic_exists+] = Indication that does the big picture exist. 1 for yes, 0 for no.
[+maxigallery.picture_height_big+] = Heigth of the big picture
[+maxigallery.picture_width_big+] = Width of the big picture
[+maxigallery.picture_height_normal+] = Heigth of the normal picture
[+maxigallery.picture_width_normal+] = Width of the normal picture
[+maxigallery.picture_height_thumb+] = Heigth of the thumbnail picture
[+maxigallery.picture_width_thumb+] = Width of the thumbnail picture

pageNumberTpl
Look for the default content in: assets/snippets/maxigallery/templates/pagenumbertpl.html

[+maxigallery.pageurl+] = Url to that page
[+maxigallery.pagenumber+] = Page number
[+maxigallery.pagecount+] = Total number of pages
[+maxigallery.currentpage+] = Current page number

clearerTpl
Look for the default content in: assets/snippets/maxigallery/templates/clearertpl.html

No placeholders

Also, look at the default css styles in: assets/snippets/maxigallery/css/default.css

Instructions

Important Notices

NOTE! If you have PHx plugin installed, you need to update it to version 2.0 REV 5. If you do not have PHx installed, the snippet will use it's own PHx class, so the installation of PHx is not necessary.

PHx is among other things used to do the htmlentities conversion. So in the templates, you will find :htmlent modifier in the picture title and description placeholders. If you need to have HTML code in those fields, just remove that modifier from the templates.

See the changelog in maxigallery.txt for more info about changes.

Installation

If you allready have MaxiGallery installed and you want to test this one, rename the current maxigallery folder under assets/snippets/ to something else. Then log in to MODx Manager and copy the current maxigallery snippet code to a local text file on your computer what you can restore later.

• 1. Copy the assets folder in to modx site root
• 2. CHMOD assets/galleries/ folder to 0777 (unless you have phpsuexec or similar installed)
• 3. Copy paste the contents of maxigallery.txt as new snippet
  • Use the same name as the old one, if you want to check that does the galleries still work with this one. Or create MaxiGallery2 or something if you want to test this as new snippet.
  
  
• View your site

Known problems

• The new Slimbox and SmoothSlideshow scripts, or to be more exact, MooTools will break the javascript menu in MODxHost template in 0.9.5
• MooTools will also break the AjaxSearch snippet
• Slimbox won't work when QuickEdit is enabled and visible. SmoothSlideshow also has some quirks when QuickEdit is in use and spawns javascript errors on picture change.
• SmoothSlideshow has CSS collision in MODxCSS template

Please report your problems in the support forums if you have some. Thanks! :)