Works with MODx Version(s): All
Submitted: Feb 20th 2007 | License: GPL - GNU Public | Downloads: 913
This resource has been deprecated.

Description

See changelog.txt in the archive for information on changes, I'll just go throught the new parameters and placeholders here.

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

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) ].

New parameters in RC 1:

• &smoothgallery_width - Width for the smoothgallery div. Overflow will be hidden, so this should be the max width for biggest picture (&max_pic_size).
• &smoothgallery_height - Height for the smoothgallery div. Overflow will be hidden, so this should be the max height for biggest picture (&max_pic_size).
• &smoothgallery_showArrows - Defines will arrows be shown in the slideshow. Default: true
• &smoothgallery_showCarousel - Defines will the carousel be shown in slideshow (the part that shows the thumbnails). Default: true
• &smoothgallery_showInfopane - Defines will the info pane be shown (the part that holds picture descriptions). Default: true
• &smoothgallery_thumbHeight - Height of the thumbnails. Default: 75
• &smoothgallery_thumbWidth - Width of the thumbnails. Default: 100
• &smoothgallery_thumbSpacing - Space between thumbnails. Default: 10
• &smoothgallery_embedLinks - Should the picture open by clicking on the slide. Default: true
• &smoothgallery_fadeDuration - Duration of the fade effect. Default: 500
• &smoothgallery_timed - Defines is the slideshow timed. Default: false
• &smoothgallery_delay - Delay for the timed slideshow. Default: 9000
• &smoothgallery_preloader - Defines should the pictures be preloaded. Default: true
• &smoothgallery_slideInfoZoneOpacity - Opacity value for the info pane. Default: 0.7
• &smoothgallery_carouselMinimizedOpacity - Opacity value for the carousel when minimized. Default: 0.4
• &smoothgallery_carouselMinimizedHeight - Height of the minimized carousel. Default: 20
• &smoothgallery_carouselMaximizedOpacity - Opacity value for the carousel when maximized. Default: 0.7
• &smoothgallery_textShowCarousel - Text to show in the carousel. Default: 'pictures' text from maxigallery language file
• &admin_webgroups - Comma delimited list of web usergroup names that should be admin users. They can see all pictures in the gallery.
• &admin_webusers - Comma delimited list of web usernames that should be admin users. They can see all pictures in the gallery.
• &childgalleries_order_by - MODx document object field to sort the childgalleries by. Default: menuindex
• &childgalleries_order_direction - Childgalleries order direction. Default: ASC
• &childgalleries_ids - Comma delimited list of document id's to retrieve childgalleries from. Possible to use "all" as value to retrieve all galleries. Default: Current document
• &offset - Offset value to use for the query result set. Default: 0
• &limit - Limit value to use for the query result set. Default: 9999999
• &random_filenames - If enabled, generates random filenames to uploaded pictures. Default: false
• &disable_js_libs - If enabled, doesn't include MooTools, Prototype or Scriptaculous libraries to the document even if they are needed by the gallery display type. To be used when javascript libraries are in site template. Default: false
• &use_ftp_commands - If enabled, MaxiGallery uses PHP FTP commands to create filesystem folders for gallery pictures. This is needed in certain server environments. Default: false
• &ftp_server - FTP address to the server running MODx.
• &ftp_port - Port number for the FTP service. Default: 21
• &ftp_user - FTP username
• &ftp_pass - FTP password
• &gal_query_ids - ID's of the gallery documents to retrieve pictures from
• &query_level_limit - Defines how many levels deep to go from the parent &gal_query_ids documents. Default: 1
• &pic_query_ids - ID's of single pictures to retrieve

New values for parameters:

• &embedtype - New possible values [ slidebox | lightboxv2 | slimbox | slideshow | popup | external ].
• order_by - added possibility to use "random" as value for this parameter, it makes maxigallery show pictures in random order or a random picture in childgalleries display mode

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.childgallerycount+] = The number of childgalleries if display=`childgalleries` is used
[+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.picscount+] = The number of pictures in this gallery
[+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/
[+maxigallery.picscount+] = The number of pictures in this gallery

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

draggableTpl
Look for the default content in: assets/snippets/maxigallery/templates/draggabletpl.html
This is the template for the draggable picture sorting popup.

[+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.path_to_gal+] = the path where the current gallery images are. eg. assets/galleries/120/
[+maxigallery.path+] = the path where MaxiGallery is installed eg. assets/snippets/maxigallery/


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

Instructions

Important Notices

NOTE! If you have PHx plugin installed, make sure it's the latest one. If you don't have it, PHx class that is included in MaxiGallery will be used.

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.txt for more info about changes.

Installation

If you allready have MaxiGallery installed and you want to test this separately, copy these files under assets/snippets/maxigallery_05_rc1 for example and define that in the MAXIGALLERY_PATH constant in maxigallery.txt. Then simply use different name for the snippet.

• 1. Copy the assets folder in to modx site root (unless you want to install in some other folder, see above)
• 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

• None! (hmm.. that's really true.. can't think of any, yay!) :)

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