Classic Websites Platform: Widget List

HAVE A RESPONSIVE TEMPLATE? If so, please instead consult the
Responsive Template section for support. 

 

A comprehensive listing of all PhotoShelter Customization Widgets is shown below. Not all widgets are available in all page templates; for a listing of widgets available to specific pages, go to that page's template.

Note that all PhotoShelter Widgets are enclosed in double square braces. (e.g. [[widget]]

 

Options: Some PhotoShelter widgets have options to modify their behavior, e.g. whether to display the filename of an image below the thumbnail. Widget options go inside the widget tag and consist of a name and an optional value ([option name]=[option value]). The option value may be quoted with either single or double quotes; if the value contains spaces, quotes are required. Options are indicated in each widget's description.

Cascading Style Sheets (CSS): Most PhotoShelter widgets output HTML with identifier ("ID") or CSS class tags. These allow you to apply your own custom CSS styles to these widgets. Applicable CSS class or ID selectors are indicated in each widget's description.

 

[[about_page_url]] About Page URL
The URL for your About page.
 
[[activation_page_url]] Activation Page URL
The URL for the account activation page, so that users may try resending their account activation email.
If you don't receive your activation e-mail, please <a href="[[activation_page_url]]">click here</a> to try resending it.
 
[[add_to_cart_link]] Add to Cart Link
A link which brings up the "Add to Cart" dialog box.
  • If in the Search Results Image Display or Gallery Image Display page, it allows the user to add the current image to the shopping cart. The link is hidden if the image is not priced for sale.
  • If in the Gallery Display page, it brings up a batch select screen which allows the user to select up to 100 images to add to the cart. The link is hidden if none of the images in the gallery are priced for sale, or the gallery contains more than 1000 images.
Note that the link only appears if the current image or images in the current gallery are priced for sale. By default, the link contains the text "Add to Cart"; different HTML can be specified using a widget option.

jQuery note: This widget utilizes the jQuery JavaScript library. If you are already including a version of jQuery in your site, you may need to check for conflicts when including this widget.

text=[your text]
Specifies the text to use for the link. HTML is allowed. 

image=[your image URL]
Specifies the image URL to use for the link. Overrides the text option. 

type=[pricing type]
Specifies which pricing type should be displayed when the user clicks the link. If the specified pricing type is not available for the current image, it will default to your site's default pricing type (Prints if not specified).
  • prints: Open the Prints tab.
  • products: Open the Products tab.
  • packages: Open the Packages tab.
  • downloads: Open the Downloads tab.
  • personal-use: Open the Downloads tab and select Personal Use.
  • commercial-use: Open the Downloads tab and select Commercial Use (Rights Managed or Royalty Free).
  • A.add_to_cart_link
[[add_to_cart_link text="add to shopping cart"]]
[[add_to_cart_link image="http://www.mysite.com/images/cart.gif"]]
 
[[add_to_lightbox_link]] Add to Lightbox Link
A link which adds the current image to the Lightbox. By default, the link contains the text "Add to Lightbox"; different HTML can be specified using a widget option.
text=[your text]
Specifies the text to use for the link. HTML is allowed. 

image=[your image URL]
Specifies the image URL to use for the link. Overrides the text option.
  • A.add_to_lightbox_link
[[add_to_lightbox_link text="add to lightbox"]]
[[add_to_lightbox_link image="http://www.mysite.com/images/lightbox.gif"]]
 
[[base_url]] Base URL
The base URL for your site, e.g. "myname.photoshelter.com"
 
[[batch_download_link]] Batch Download Link
A link to the Batch Downloader for the current gallery. By default, the link contains the text "Click to Batch Download"; different HTML can be specified using the "text" widget option.

NOTE: The batch download link will always be displayed. If the user is not logged in and the gallery requires an invitation for downloads, they will be prompted to log in before they can proceed to the batch download page. Theno_login and no_invite widget options have been discontinued.

text=[your text]
Specifies the text to use for the link. HTML is allowed.

  • A.batch_download_link
[[batch_download_link text='Hi-resolution Download']]
 
[[buy_prints]] Buy Prints Link
Displays the link for prints purchase, if the image is priced accordingly. By default, the link contains the text "Buy Prints"; different HTML can be specified using widget options.
text=[your text]
Specifies the text to use for the link. HTML is allowed. 

image=[your image URL]
Specifies the image URL to use for the link. Overrides the text option.
 
[[buy_personal_use]] Buy Personal Use
Displays the link for personal use purchase, if the image is priced accordingly. By default, the link contains the text "Buy Personal Use"; different HTML can be specified using widget options. Widget options are identical to the[[buy_prints]] widget.
 
[[buy_rights_managed]] Buy Rights-Managed Link
Displays the link to either the rights-managed pricing window or inquiry form, if the image is priced accordingly. By default, the link contains the text "Buy Rights-Managed"; different HTML can be specified using widget options. Widget options are identical to the [[buy_prints]] widget above.
 
[[buy_royalty_free]] Buy Royalty Free Link
Displays the link for royalty-free purchase, if the image is priced accordingly. By default, the link contains the text "Buy Royalty-Free"; different HTML can be specified using widget options. Widget options are identical to the[[buy_prints]] widget above.
 
[[buy_not_priced]] "Not Priced" Message
Displays specified text when an image is not priced for sale. If the "text" widget argument is not specified, a default message is shown: This image is not available for online sale. Please contact us regarding the legal use of this image.
text=[your text]
Specifies the text to use for the link. HTML is allowed. 

[[buy_not_priced text="(unavailiable for online purchase)"]]
 
[[cart_icon_js]] Cart Icon JavaScript
Outputs JavaScript code that enables dynamic cart display functionality, which includes:
  • A dynamic display of the number of items currently in the cart.
  • Contextual style changes based on cart status (empty or filled).
  • Contextual display of "checkout" buttons.
  • A mouseover cart summary overlay ("tray").

Generally, this functionality will work in conjunction with a site's "Cart" navigational icon/link. The[[cart_icon_js]] widget should be included only once on the page, preferrably at the top of the template.

jQuery note: This widget utilizes the jQuery JavaScript library. If you are already including a version of jQuery in your site, you may need to check for conflicts when including this widget.

The JavaScript function looks for DOM elements with the following CSS class selectors:

  • .psCartIcon: The DOM element representing the site "CART" link or icon.
  • .psCartIconNum: The DOM element that dynamically displays the number of items in the cart. Typically this will be a SPAN or DIV within the .psCartIcon element.
  • .psCartIconCheckout: The DOM element representing a dynamic cart "CHECKOUT" link and/or icon.

When the shopping cart is empty:

  • The .psCartIcon element is left unaltered.
  • The .psCartIconCheckout element is hidden using the jQuery.toggle() function.
  • If the "autoHideNum" option has been specified, the .psCartIconNum is hidden using thejQuery.hide() function.

When the shopping cart contains at least one item:

  • The .psCartIcon element has the classname .filled added to its class attribute.
  • The .psCartIconCheckout element is shown using the jQuery.toggle() function.
  • The .psCartIconNum element's innerHTML is populated with the number of items in the cart. If the "autoHideNum" option has been specified, it is shown using the jQuery.show() function.

When the "trayAnchor" option is specified (see "options" below):

  • A mouseover cart summary "tray" is displayed when the user mouses over the .psCartIcon element. It is hidden when the user moves their mouse away.
  • The tray contains a by-image summary of the items in the cart, the estimated shipping amount and the item subtotal.
  • It is displayed as an overlay over the main page content, positioned just under the .psCartIconelement. The width and horizontal position of the tray is based upon that of the DOM element specified by the "trayAnchor" argument.
  • If the cart is empty, the tray is never displayed.

Important notes:

  • The [[cart_icon_js]] widget is purely JavaScript code, and does not output any HTML. It is your responsibility to provide HTML with the requisite DOM elements for it to function. See the example section below for a code illustration.
  • Any and all of the specified DOM elements are optional; you may include whichever ones you wish to use, independent of the others.
  • All dynamic functionality becomes available after the page has loaded ("ready" state), so there may be a slight delay in updating the icon display.
  • It is your responsibility to set the default CSS styles and states of these DOM elements accordingly. E.g.,.psCartIconCheckout should be set with display: none so that it does not display before the page has loaded and reached a "ready" state.
trayAnchor=[selector]
A jQuery-style selector for the DOM element the cart tray should be aligned with. The width and horizontal position of the specified DOM element will be used to position and size the cart tray overlay. JQuery selectors may be used as specified in the jQuery API documentation; in general, CSS-style selectors will be recognized, e.g. #main or TD.main. A DOM ID selector (#) is highly recommended for optimal performance. 

autoHideNum=[true|false]
Specifies whether the .psCartIconNum element should be hidden if the cart is empty. If false or not specified, the number will be displayed as "0" when the cart is empty.

parens=[parens|bracket]
Specifies whether to include parenthesis around the number of items .psCartIconNum.
  • parens: Standard parenthesis will be used, e.g. (4).
  • brackets: Square brackets will be used, e.g. [4].
A.psCartIcon {
	display: block;
	padding: 0;
	height: 20px;
}

A.psCartIcon.filled {
	padding-right: 80px;
	background: url('/images/checkout-icon.png') top right no-repeat;
}

A.psCartIcon IMG {
	float: left;
	border: none;
}

A.psCartIcon SPAN {
	float: left;
}

A.psCartIcon SPAN.psCartIconNum {
	display: none;
	color: #090;
}
[[cart_icon_js autoHideNum=true parens=bracket trayAnchor='#main']]

<a href="[[cart_url]]" title="Cart" class="psCartIcon"><span>Ca
rt</span><span class="psCartIconNum"></span><img src="/images/cart-icon.png" 
alt="cart"></a>
 
[[cart_url]] View Cart
The URL for your customized PhotoShelter Cart. The Cart is used when people purchases rights-managed images or prints from you. (Applies only if your account is set up to sell.)
<a href="[[cart_url]]">Shopping Cart</a>
 
[[contact_link]] Contact Link
Provides a link to your contact page. If the link is clicked from a page containing an image, the image will be specified in the e-mail message. Your e-mail address is not revealed.
<a href="[[contact_link]]">Contact Me</a>
 
[[contact_form]] Contact Form
Displays the contact form.
  • TABLE.contact_form: the table enclosing the contact form fields.
  • TABLE.contact_form TH: the TH table cells enclosing the form input labels, e.g. "Your Name:"
  • TABLE.contact_form TD: the TD table cells enclosing the form input text boxes
 
[[collections_galleries_list]] Combined listing of collections and galleries
Displays a combined list of galleries and collections in the current collection or at top level of your site. Galleries and collections will be intermingled and sorted in the order you have specified in your Image Browser. It is equivalent to the [[gallery_list]] and [[gallery_collection_list]] widgets combined.

IMPORTANT NOTE: In order to use this widget with pagination controls such as [[page_next]], [[page_previous]] or [[page_select]], you must include the "widget" option for those controls. For more information, please consult the documentation for those widgets.

size=[size]
Specifies the size in pixels for the thumbnails. Values between "50" and "200" are accepted. If no value is specified, the default thumbnail size (100 pixels) is used.

style=[text|list|thumbs]
Selects a display style for the collection/gallery list:
  • thumbs (default): displays list as tiled thumbnails.
  • text: displays a simple text list w/o thumbnails.
  • list: a vertical list with thumbnails.

text_position=[under|right]
Applies only to list style. Selects where to position text relative to the thumbnail:
  • right (default): to the right of the thumbnail.
  • under: under the thumbnailed, centered.

name
Display the collection/gallery name. Applies only to list and thumbs styles. 

num_items
Display the number of items (collections and galleries) in the collection/gallery (e.g. "25 galleries"). Applies only to list and thumbs styles. 

description
Display up to 50 characters of the collection/gallery description. Applies only to list andthumbs styles.
  • UL.collections_galleries_list: Containing <UL> element for all list items. Each collection/gallery name in the list is represented as a <LI> element within it.
  • UL.thumbs.collections_galleries_list: Outer UL. Applies to thumbs style option.
  • UL.thumbs.collections_galleries_list TD.slide: TD for thumbnail image. Applies to thumbs style.
  • A.collections_galleries_list_name: Collection/gallery name A tag. Use to change the style of the link.
  • SPAN.collections_galleries_list_num_items: SPAN around number of images in the collection/gallery. Use to change the font of the num_items option.
  • SPAN.collections_galleries_list_description: SPAN around collection/gallery description. Use to change the font of the description option.
[[collections_galleries_list size=150 style=thumbs name num_items]]
 
[[custom_page1_url]] Custom Page 1 URL
The URL for your Custom Page 1 page.
 
[[custom_page2_url]] Custom Page 2 URL
The URL for your Custom Page 2 page.
 
[[display_options_link]] Display Options Link
A link to show thumbnail Display Options, which includes the number of thumbnails per page. By default, the link contains the text "Display Options"; different HTML can be specified using the "text" widget option.

NOTE: This widget is deprecated and should not be used for new development. Please refer to the[[view_options]] widget for comparable functionality.

text=[your text]
Specifies the text to use for the link. HTML is allowed.

  • A.display_options_link
[[display_options_link text='<img src="/img/button/display_options.gif" alt="Display Options" border="0">']]
 
[[download_link]] Image Download Link
A link to download the current image in one of the available formats. The user will be prompted to log in (if they are not already), and select one of the available download options (e.g. low-res comp or high-res file). If multiple high-res sizes are available (e.g. 600 pixel, 1200 pixel, original size), the user may select which size to download.

Note that unlike previous download widgets, the download link will always be displayed, whether or not the user is logged in or has download permission. By default, the link contains the text "Click to Download Image"; different HTML can be specified using the "text" widget option.

text=[your text]
Specifies the text to use for the link. HTML is allowed.

no_login=[your text]
Specifies the message to display if the user is not logged in. The message will be displayed along with a form to allow the user to log in and continue with the download. HTML is allowed, but it is recommended to keep formatting and the length of the message to a minimum. If not specified, the default message is shown: Please log in to access image downloads.

no_invite=[your text]
Specifies the message to display if the user does not have any download access to the current image. HTML is allowed. If not specified, the default message is shown: Pleasecontact us for download access to this image. (A link is included to your Contact page.)
  • A.download_link
[[download_link text='Download Image' no_login='Please log in to access image downloads.']]
 
[[email_to_friend_link]] Email to a Friend Link
A link for the user to email the current image or gallery to a friend. By default, the link contains the text "Email to a Friend"; different HTML can be specified using a widget option.
text=[your text]
Specifies the text to use for the link. HTML is allowed. 

image=[your image URL]
Specifies the image URL to use for the link. Overrides the text option.
  • A.email_to_friend_link
[[email_to_friend_link text="Email to a Friend"]]
[[email_to_friend_link image="http://www.mysite.com/images/email_to_friend.gif"]]
 
[[feature_galleries]] My Feature Gallery Display
Displays your featured galleries on the page. Each featured gallery is represented by a screen-size image, and can also include the gallery name and description using the "name" and "description" options, respectively. The order in which you specify "name" and "description" will affect the order in which they appear under the image. The image and name are linked to the Gallery Display page.

size=[size]
Specifies the size in pixels for the featured gallery images. Values between "250" and "1000" are accepted. If no value is specified, the default image size (500 pixels) is used.

width=[width] height=[height]
Specifies the width and height in pixels for the featured gallery image. Values between "250" and "1000" are accepted. Both width and height are required, and will supercede the sizeoption.
Note that the width/height values specify a bounding box for the image (i.e., the image will always be scaled to fit within both dimensions), and the aspect ratio of the original image is always preserved.

random
Display a single featured gallery, selected at random from the list of featured galleries.

name
Display the gallery name below the image.

description
Display up to 100 characters of the gallery description.

style=[list]
A fully CSS-based list-item formatting
  • #feature_galleries_name: when style="list", this controls the UL element.
  • DIV.feature_galleries_name: applies to name option.
  • DIV.feature_galleries_description: applies to description option.
[[feature_galleries size='750' name description]]
 
[[feature_gallery_slideshow]] Flash-based Feature Gallery Slideshow
Displays a Flash-based slideshow for a gallery in your Featured Galleries list. If you have more than one Featured Gallery, one will be selected at random.

Slideshow settings can be customized via a slideshow widget preset, or the size and background color may be specified using widget options (the aspect ratio will be fixed at 3:2).
preset=[preset name]
Specifies a saved preset for the embeddable slideshow widget. This allows you to extensively customize the slideshow's settings. These settings take precedence over other widget options (size or background).

NOTE: If the saved preset is modified, any customization pages using that preset will also change. If the preset is not found, the size and background options will be used, if specified. 

size=[size]
Specifies the size (width) of the slideshow in pixels; the height is always 2/3rd of the size. The default size is 750x500 pixels. 

background=[color hex code]
Specifies the background color of the slideshow. Use a hex color code (e.g. "#AA3300"). The default color is #AAAAAA.
[[feature_gallery_slideshow size="900" background="#CCCCCC"]]
 
[[gallery_photowall]] Gallery Photo Wall
Displays a tiled "Photo Wall" presentation of featured or recent galleries.

jQuery note: This widget utilizes the jQuery JavaScript library. If you are already including a version of jQuery in your site, you may need to check for conflicts when including this widget.

width=[width]
Specifies the width in pixels for the photo wall. Defaults to 750 pixels. 

source=[feature|recent]
Specifies whether to use Featured Galleries (both Large and Small) or Recently Updated galleries as the source for the photo wall. 

max_count=[number]
Sets a limit for the number of recent galleries to use for the photo wall, if the source=recentoption has been specified. 

aspect=[natural|rectangular|square|constrain_height]
Sets the aspect ration for the images. Defaults to "natural."
  • natural: The original aspect ratio of the image will be preserved as closely as possible.
  • rectangular: Images will be cropped to fit a rectangular (4:3) aspect ration.
  • square: Images will be cropped to fit a square (1:1) aspect ratio.
  • constrain_height: Stacks images from left to right. Image aspect ratio will be preserved but scaled to fit within the height set by rowheight.

bilevel=[true|false]
Display small featured or less recent galleries as smaller thumbnails. Defaults to true. 

border_radius=[size]
The rounded corner radius for thumbnails. The size should be the full CSS value, with units (e.g. border_radius="10px"). Defaults to "5px"; specify "none" to disable.
NOTE: border radius is not supported by Internet Explorer 8 and earlier. 

gallery_name=[on|off|hover]
Display the name of the gallery over each gallery thumbnail. If hover, gallery names will be displayed when moused over by the user. Defaults to off. 

hover=[light|dark|off]
Effect to apply to the gallery thumbnails on mouse over. Defaults to off.
  • light: Apply light mask, remove on hover.
  • dark: Apply dark mask, remove on hover.

padding=[pixels]
The number of pixels for padding between images. It should NOT include units such as "px" (e.g. padding=10). Defaults to 5 pixels. 

rowheight=[pixels]
Note: Only applies when aspect=constrain_height.
The number of pixels for height of each row of images. It should NOT include units such as "px" (e.g. rowheight=100). Defaults to 150 pixels. 

watermark=[true|false]
Display watermark in large thumbnails. Defaults to false. 

  • DIV.gallery_photowall: Containing DIV for the Photo Wall.
  • DIV.gallery_photowall_name: Containing DIV for the gallery name.
[[gallery_photowall width=900 source=feature hover=true border_radius=8px padding=2]]
 
[[gallery_image_caption]] Gallery Image Caption

NOTE: this widget is deprecated. Use [[iptc_caption]] instead.

Displays the IPTC caption for an image in your gallery. If the caption is longer than 500 characters, it is "collapsible," with a link to display the entire text past 500 characters.
 
[[gallery_collection_list]] Listing of gallery collections
Displays a list of gallery collections. The list can be displayed in different styles based on the style widget option. For thumbs and list styles, a thumbnail image from the most recently modified gallery in the collection will be used to represent the collection.
size=[size]
Specifies the size in pixels for the thumbnails. Values between "50" and "200" are accepted. If no value is specified, the default thumbnail size (100 pixels) is used.

style=[text|list|thumbs]
Selects a display style for the gallery list:
  • thumbs (default): displays list as tiled thumbnails.
  • text: displays a simple text list w/o thumbnails.
  • list: a vertical list with thumbnails.

text_position=[under|right]
Applies only to list style. Selects where to position text relative to the thumbnail:
  • right (default): to the right of the thumbnail.
  • under: under the thumbnailed, centered.

name
Display the name of the gallery collection. Applies only to list and thumbs styles. 

num_galleries
Display the number of items (collections and galleries) in the collection (e.g. "5 galleries"). Applies only to list and thumbs styles.
  • UL.gallery_list_collection: Containing <UL> element for all list items. Each gallery collection name in the list is represented as a <LI> element within it. Applies only to textstyle option
  • TABLE.gallery_list_collection: Outer TABLE. Applies to list style option.
  • UL.thumbs.gallery_list_collection: Outer UL. Applies to thumbs style option.
  • UL.thumbs.gallery_list_collection TD.slide: TD for thumbnail image. Applies tothumbs style.
  • A.gallery_list_collection_name: Gallery collection name A tag. Use to change the style of the link.
  • SPAN.gallery_list_collection_num_galleries: SPAN around # of items in the collection. Use to change the style of the text.
[[gallery_collection_list size=150 style=thumbs name num_galleries]]
 
[[gallery_collection_link]] Back to Gallery Collection Link
Displays the link for returning to the gallery collection that contains the current gallery or collection, if applicable. Use this to create "breadcrumb" links back to the Gallery Collection Display page for the containing collection. If the current gallery was not viewed as part of a gallery collection, or the current collection is not contained within another collection, no link will be displayed.

By default, the link contains the text "Back to [name of collection]"; different HTML can be specified using a widget option.
prefix=[your text]
Specifies text to display before the gallery collection name in the link (defaults to "Back to"). You can speciy a blank value to omit the prefix entirely and display only the collection name. 

text=[your text]
Specifies the text to use for the link. HTML is allowed. 

image=[your image URL]
Specifies the image URL to use for the link. Overrides the text option.
  • A.gallery_collection_link: the <A> hyperlink tag for the link
  • NOTE: A CSS class can be used in conjunction with or as an alternative to the widget arguments to change the look and behavior of the link (e.g. to provide mouseover [A:hover] behavior).
[[gallery_collection_link prefix=""]]
[[gallery_collection_link text="Go Back to Collection"]]
[[gallery_collection_link image="http://www.mysite.com/images/back.gif"]]
 
[[gallery_collection_name]] Gallery Collection Name
Displays the name of the gallery collection on the current page.
 
[[gallery_collection_description]] Gallery Collection Description
Displays the description for your gallery collection. If the description is longer than 500 characters, it is "collapsible," with a link to display the entire text past 500 characters.
 
[[gallery_collection_search_box]] Gallery Collection Search Box
Displays a keyword search box for searching within the current collection or the entire archive.
mode=[collection|archive]
Specifies whether to search the collection or the entire archive. If not specified, options will be displayed to allow the user to select the search mode.
  • collection: search only within the current collection.
  • archive: search the entire archive.

label=[label]
Specifies the text label to display next to the search box; if not specified, "Search:" is displayed. 

sort=[rank|date]
Specifies the sort order for the search. Defaults to "rank."
  • rank: sort by relevance
  • date: sort by date
  • SPAN.gallery_collection_box: SPAN containing label of the search box.
[[gallery_collection_box mode=gallery label="Search this collection:"]]
 
[[gallery_collection_toc]] "Table of Contents" list of gallery collections
Displays a "table of contents" style listing of top-level gallery collections and the galleries they contain. Galleries are listed within a <UL> list under each gallery collection.
  • DIV.gallery_collection_toc: Containing <DIV> for each collection listing.
  • DIV.gallery_collection_toc_name: Containing <DIV> for the name of each gallery collection.
  • A.gallery_collection_toc_name: Gallery collection name A tag. Links to the Gallery Collection Display page for that collection.
  • UL.gallery_collection_toc: Containing <UL> element for the list of galleries within each collection. Each gallery name in the list is represented as a <LI> element within it, and links to the Gallery Display page for that gallery.
 
[[gallery_collection_url]] Gallery URL
 
 
[[gallery_description]] Gallery Description
Displays the description for your gallery. If the description is longer than 500 characters, it is "collapsible," with a link to display the entire text past 500 characters.
 
[[gallery_comment_box]] Gallery Comment Box
Displays the gallery comment and rating system, which allows logged-in users to leave a comment on and/or rate a gallery image. If a user is not logged in, a message with a link to the login page is displayed: You must be logged in to leave comments. Click here to log in.
title=[your text]
Specifies the title for the comment/rating box. Defaults to "Leave a Comment/Rating." 

  • DIV.gallery_comment_box: the <div> containing the comment and rating elements.
  • DIV.gallery_comment_box H3: the <h3> containing the box title.
  • DIV.gallery_comment_box_no_login: a <div> containing a message if the user is not logged in.
[[gallery_comment_box title="Leave a Comment!"]]
 
[[gallery_list]] Listing of galleries
Displays a list of galleries in the current collection or at the top level of your site. The list can be displayed in different styles based on the style widget option.
size=[size]
Specifies the size in pixels for the thumbnails. Values between "50" and "200" are accepted. If no value is specified, the default thumbnail size (100 pixels) is used.

style=[text|list|thumbs]
Selects a display style for the gallery list:
  • thumbs (default): displays list as tiled thumbnails.
  • text: displays a simple text list w/o thumbnails.
  • list: a vertical list with thumbnails.

text_position=[under|right]
Applies only to list style. Selects where to position text relative to the thumbnail:
  • right (default): to the right of the thumbnail.
  • under: under the thumbnailed, centered.

name
Display the gallery name. Applies only to list and thumbs styles. 

num_images
Display the number of images in the gallery (e.g. "25 images"). Applies only to list andthumbs styles. 

description
Display up to 50 characters of the gallery description. Applies only to list and thumbs styles.
  • UL.gallery_list: Containing <UL> element for all list items. Each gallery name in the list is represented as a <LI> element within it.
  • UL.thumbs.gallery_list: Outer UL. Applies to thumbs style option.
  • UL.thumbs.gallery_list TD.slide: TD for thumbnail image. Applies to thumbs style.
  • A.gallery_list_name: Gallery name A tag. Use to change the style of the link.
  • SPAN.gallery_list_num_images: SPAN around number of images in the gallery. Use to change the font of the num_images option.
  • SPAN.gallery_list_description: SPAN around gallery description. Use to change the font of the description option.
[[gallery_list size=150 style=thumbs name num_images]]
 
[[gallery_list_url]] Gallery List Page URL
The URL for your Gallery List page. The Gallery List page displays a list of your top-level galleries and collections.
<a href="[[gallery_list_url]]">Galleries</a>
 
[[gallery_date_created]] Gallery Creation Date
Displays the date the gallery was created.
 
[[gallery_date_modified]] Gallery Modification Date
Displays the date the gallery was last modified.
 
[[gallery_name]] Gallery Name
Displays the name of the gallery on the current page.
 
[[gallery_search_box]] Gallery Search Box
Displays a keyword search box for searching within the current gallery or the entire archive.
mode=[gallery|archive]
Specifies whether to search the gallery or the entire archive. If not specified, options will be displayed to allow the user to select the search mode.
  • gallery: search only within the current gallery.
  • archive: search the entire archive.

label=[label]
Specifies the text label to display next to the search box; if not specified, "Keywords:" is displayed. 

sort=[rank|date]
Specifies the sort order for the search. Defaults to "rank."
  • rank: sort by relevance
  • date: sort by date
  • SPAN.gallery_search_box: SPAN containing label of the search box.
[[gallery_search_box mode=gallery label="Search this gallery:"]]
 
[[gallery_slideshow]] Flash-based Gallery Slideshow
Displays a Flash-based slideshow for the current gallery. Slideshow settings can be customized via a slideshow widget preset, or the size and background color may be specified using widget options (the aspect ratio will be fixed at 3:2).
preset=[preset name]
Specifies a saved preset for the embeddable slideshow widget. This allows you to extensively customize the slideshow's settings. These settings take precedence over other widget options (size or background).

NOTE: If the saved preset is modified, any customization pages using that preset will also change. If the preset is not found, the size and background options will be used, if specified. 

size=[size]
Specifies the size (width) of the slideshow in pixels; the height is always 2/3rd of the size. The default size is 750x500 pixels. 

background=[color hex code]
Specifies the background color of the slideshow. Use a hex color code (e.g. "#AA3300"). The default color is #AAAAAA.
[[gallery_slideshow size="900" background="#CCCCCC"]]
 
[[gallery_slideshow_link]] Gallery Slideshow Link
A link to the Flash slideshow page for the current gallery. By default, the link contains the text "Click to View Slideshow"; different HTML can be specified using the "text" widget option.

text=[your text]
Specifies the text to use for the link. HTML is allowed.

  • A.gallery_slideshow_link
[[gallery_slideshow_link text='<img src="/img/button/slideshow.gif" alt="View Slideshow" border="0">']]
 
[[gallery_social]] Social Network Sharing Panel
Displays a list of options for sharing a gallery on social and bookmarking sites.

style=[dark]
Specifies the icon style to use. By default, icons are light gray (#AAAAAA). A "dark" style (#666666) may be specified. 

 
[[gallery_image_social]] Social Network Sharing Panel
Displays a list of options for sharing a gallery image on social and bookmarking sites.

style=[dark]
Specifies the icon style to use. By default, icons are light gray (#AAAAAA). A "dark" style (#666666) may be specified. 

 
[[gallery_image_filmstrip]] Gallery Image FilmStrip
Provides a filmstrip navigation mechanism for the single image view of a gallery. Gives the viewer a supplemental way to scroll through images without reverting to the full thumbnail view.
size=[width]
Specifies the total width of the filmstrip object. The widget uses this number in conjunction with the thumb_cnt parameter to fit the largest possible thumbs into the specified width.

thumb_cnt=[any odd number]
Number of thumbnails to display in filmstrip. Defaults to 5, must be an odd number. 
  • DIV.gallery_image_filmstrip: Containing <div> for the filmstrip
[[gallery_image_filmstrip width=600 thumb_cnt=5]]
 
[[gallery_thumbs]] Gallery Thumbnails
Displays a tiled thumbnail view of the images contained within the current gallery. The order in which you specify "text," "filename," "filesize," and "dimensions" options will affect the order in which they appear under the thumbnail.

The "add_to_cart_link" and "add_to_lightbox_link" options create links inside a separate DIV block at the bottom of each thumbnail LI. The DIV is assigned a CSS selector thumb_links; a default style is specified in the PhotoShelter sample CSS file included in the default Master Template:
http://www.photoshelter.com/css/custom/sample.css
size=[size]
Specifies the size in pixels for the thumbnails. Values between "50" and "200" are accepted. If no value is specified, the default thumbnail size (100 pixels) is used.

preview
Turns on the image preview when the users passes their mouse over the thumbnail.

preview_delay=[time]
Specifies the time in milliseconds before launching an image preview, if enabled. Values between 50 and 3000 are accepted. If no value is specified the default delay is 500 milliseconds (.5 seconds).

preview_zoom=[zoom]
Specifies the magnification of the existing thumbnail image in an image preview, if enabled. Values between "1" and "3" are accepted. The default zoom is "2.25". (Note: The maximum preview size is 450px applied to the longest image dimension.)

preview_speed=[time]
Specifies the animation time in milliseconds of the image preview, if enabled. Values between "0" and "1000" are accepted, where "0" disables the animation effect. By default, animation is disabled.

index
Display the image index number (e.g. "5.") under each thumbnail. 

iptc=[field] SEO
Display a specified IPTC field under each thumbnail. Options include:
  • caption (Gallery image caption if available; otherwise IPTC Caption)
  • title (IPTC Title)
  • headline (IPTC Headline)

iptc_length
The maximum length of the IPTC field, if displayed. Values between 10 and 255 are accepted; if the IPTC value is longer than the specified length, it will be truncated with ellipsis (...). The default length is 50 characters. 

filename SEO
Display the image file name (e.g. "IMG4012.jpg") under each thumbnail. If the index option above is also specified, the filename will be on the same line (e.g. "5. IMG4012.jpg"). 

filename_length
The maximum length of a file name, if displayed. Values between 10 and 255 are accepted; if the file name is longer than the specified length, it will be truncated with ellipsis (...). The default length is 15 characters. 

filesize
Display the image file size (e.g. "2.5MB") under each thumbnail. 

dimensions
Display the image dimensions in pixels (e.g. "1600x1200") under each thumbnail. 

add_to_lightbox_link=[html code]
Display an "add to lightbox" link for each thumbnail image. You may specify your own HTML code for the link as the value of the option. If no html code is specified, the default PhotoShelter "+LIGHTBOX" button will be used.

add_to_cart_link=[html code]
Display an "add to cart" link for each thumbnail image. It will only be displayed for images which are priced for sale. You may specify your own HTML code for the link as the value of the option. If no html code is specified, the default PhotoShelter "+CART" button will be used.
  • UL.thumbs.gallery_thumbs: Containing <UL> element for all thumbnail tiles. Each thumbnail tile is represented as a <LI> element within it.
  • UL.thumbs.gallery_thumbs TD.slide: TD for thumbnail image.
  • TD.gallery_thumbs.text: TD for text under thumbnail image (index, filename etc.)
  • DIV.thumb_links: A DIV containing the add_to_cart_link and add_to_lightbox_link link options.
  • DIV.thumb_links A.thumb_links_lightboxDIV.thumb_links A.thumb_links_cart: the A tag used to link the add_to_lightbox_link and add_to_cart_link links, respectively.
[[gallery_thumbs index filename filesize]]
[[gallery_thumbs filename add_to_lightbox_link]]
[[gallery_thumbs filename add_to_lightbox_link='+lightbox' add_to_cart_link='<img src="http://myserver.com/images/cart.gif" border="0">']]
 
[[gallery_url]] Gallery URL
The URL for the Gallery Show page that corresponds to the current image. Use this on the Gallery Image Display page to create links back to the containing gallery.
<a href="[[gallery_url]]">Back to [[gallery_name]]</a>
 
[[homepage_url]] Homepage URL
The URL for your public PhotoShelter homepage. Use this to create links to your homepage.
<a href="[[homepage_url]]">My Homepage</a>
 
[[image]] Image Display
Displays the image for the current page. The image is set as a HTML table cell (<TD>) background for image security purposes.
size=[size]
Specifies the size in pixels for the image. Values between "250" and "1000" are accepted. If no value is specified, the default image size (500 pixels) is used.

width=[width] height=[height]
Specifies the width and height in pixels for the image. Values between "250" and "1000" are accepted. Both width and height are required, and will supercede the size option.
Note that the width/height values specify a bounding box for the image (i.e., the image will always be scaled to fit within both dimensions), and the aspect ratio of the original image is always preserved.

zoom=[zoomsize]
Specifies the size of the enlarged preview overlay image in pixels. Values between "250" and "1000" are accepted. Omit this option to turn off image zoom.
  • TABLE.image
[[image size='800' zoom='1000']]
 
[[image_date_created]] Image Creation Date
Displays the date the current image was created. (e.g. "9 December 2005")
 
[[image_date_modified]] Image Modification Date
Displays the date the current image was last modified. (e.g. "9 December 2005")
 
[[image_dimensions]] Image Original Dimensions
Displays the dimensions (height x width) of the current image. (e.g. "1600x1200")
 
[[image_filename]] Image File Name
Displays the file name of the current image. (e.g. "IMG4021.jpg")
 
[[image_filesize]] Image File Size
Displays the file size of the current image. (e.g. "953kB")
 
[[image_galleries]] Image Galleries
Displays a comma-delimited list of galleries the image is contained in. Each gallery name is linked to the gallery.
prefix=[prefix]
Text to include before the list of galleries. It will be conditionally displayed only if there is at least one gallery in the list.
  • A.image_galleries: the gallery name hyperlink.
[[image_galleries prefix='Contained in galleries: ']]
 
[[image_id]] Image ID
Displays the ID of the current image.
 
[[image_index]] Image Index Number
Displays the index number of the current image in a gallery or search results set. (e.g. "15.")
 
[[image_model_release]] Image Model Release
Indicates whether the current image has been marked as model released. By default, "Yes" or "No" will be shown; these values may be changed using widget options.
yes=[your text]
Specifies the text to display when the image has been marked as model released. HTML is allowed. 

no=[your text]
The text to display when the image has not been marked as model released. HTML is allowed. A blank value (two quotes) may be specified if you do not want to display any text.
[[image_model_release yes="<b>This image has been released by the model.</b><br><br>" no=""]]
 
[[image_property_release]] Image Property Release
Indicates whether the current image has been marked as property released. By default, "Yes" or "No" will be shown; these values may be changed using widget options.
yes=[your text]
Specifies the text to display when the image has been marked as property released. HTML is allowed. 

no=[your text]
The text to display when the image has not been marked as property released. HTML is allowed. A blank value (two quotes) may be specified if you do not want to display any text.
[[image_property_release yes="<b>This image has been released by the property owner.</b><br><br>" no=""]]
 
[[image_keywords]] Image Keywords List
Displays a list of keywords associated with the current images. Each keyword includes a checkbox to allow searching by selected keywords. You can specify an optional "style" to change the display behavior; by using the "list" style and providing appropriate CSS, it is possible to lay out the keywords in different ways (e.g. in columns).
style=[text|list|comma]
Selects a display style for the gallery list:
  • text: a simple break (<BR>) delimited list. This is the default behavior.
  • list: a <UL> list using <LI> elements for each keyword and checkbox.
  • comma: a simple comma-delimited list. Each keyword is linked to a search for that term.
  • FORM.image_keywords: Containing <FORM> element for the keyword search box.
  • INPUT.image_keywords_submit: The submit button input element.
  • FORM.image_keywords UL: Containing <UL> element for the keyword list. Applies only to the list style.
  • FORM.image_keywords UL LI: Containing <LI> element for eacy keyword item. Applies only to the list style.
[[image_keywords style=list]]
 
[[image_social]] Social Network Sharing Panel
Displays a list of options for sharing an image on social and bookmarking sites.

style=[dark]
Specifies the icon style to use. By default, icons are light gray (#AAAAAA). A "dark" style (#666666) may be specified. 

 
[[image_url]] Image Public URL
Displays a publicly-accessible URL for viewing the current image. This is for display purposes only (e.g. for clients to cut-and-paste), and should not be used for linking within your site.
URL for this image: [[image_url]]
 
[[iptc]] IPTC Field (user specified)
Displays a user-selectable field from the current image's IPTC metadata. Multiple fields may be specified as "fallbacks" for blank fields, as well as a default value if all specified fields are blank. E.g. in the following example:
[[iptc field="TITLE,HEADLINE,AUTHOR" default="(title n/a)"]]
The IPTC Title will be displayed; if it is blank, the Headline will be displayed; and if that is blank, the Author will be displayed. If all three are blank, the default value "(title n/a)" will be displayed.

The following IPTC fields are available:
  • CAPTION
  • TITLE
  • HEADLINE
  • SDATE (Date Created)
  • PUB_DATE (Date Published)
  • KEYWORDS
  • INSTRUCTIONS (Special Instructions)
  • COPYRIGHT
  • RIGHTS (Usage Rights)
  • CREDIT (Credit/Provider)
  • CITY
  • STATE
  • COUNTRY
  • AUTHOR
  • SOURCE
  • TRANS_REF (Job Identifier)
  • POSITION (Author Title)
 
field=[fields] required
The field(s) to display, comma delimited, in order of preference. 

default=[your text]
The text to display if all the specified fields are blank.
[[iptc field="CITY"]]
[[iptc field="TITLE,HEADLINE,AUTHOR" default="(title n/a)"]]
 
[[iptc_caption]] IPTC Caption
Displays the IPTC Caption for the current image. If the caption is longer than 500 characters, it is "collapsible," with a link to display the entire text past 500 characters.
 
[[iptc_copyright]] IPTC Copyright
Displays the IPTC Copyright for the current image. If the copyright field is blank, your account name (user or organization name) is used by default.
 
[[iptc_location]] IPTC Location
Displays the IPTC City, State, and Country for the current image.
 
[[lightbox_url]] Lightboxes Page URL
The URL for your Lightboxes page. When a user is logged in, the Lightboxes page displays a list of all their personal and shared lightboxes; when not logged in, it will either display their temporary lightbox if available, or prompt them to log in to see their full lightbox list.
<a href="[[lightbox_url]]">Lightbox</a>
 
[[login_form]] Login Form
Displays the login form.
  • TABLE.login_form: the table enclosing the login form fields.
  • TABLE.login_form TH: the TH table cells enclosing the form input labels, e.g. "Password:"
  • TABLE.login_form TD: the TD table cells enclosing the form input text boxes
 
[[login_link]] Login Link
A link to the login page. By default, the link contains the text "Log in"; different HTML can be specified using the "text" widget option.

NOTE: Previously it was stated that the widget was only displayed if the user is not currently logged in; however it has been determined that this is not always the case due to complications with vanity domain names and cross-domain authentication. Therefore the widget will now be displayed at all times.

text=[your text]
Specifies the text to use for the link. HTML is allowed.

  • A.login_link
[[login_link text='Log in']]
 
[[login_url]] Login Page URL
The URL for your login page. If a user is already logged in, they will be redirected to their My Account page.

Note: As an alternative you can use the [[login_link]] widget.
<a href="[[login_url]]">Log in</a>
 
[[logout_link]] Logout Link
A link to log out the current user. It will only be displayed if the user is currently logged in. By default, the link contains the text "Log out"; different HTML can be specified using the "text" widget option.

text=[your text]
Specifies the text to use for the link. HTML is allowed.

  • A.logout_link
[[logout_link text='Log out']]
 
[[page_next]]  [[page_previous]] Page Navigation Buttons
Displays navigation buttons to go to the next or previous page. Either button will only appear when a corresponding next or previous exists, e.g. when moving between images in a gallery or viewing pages of search results. The default button is a text link called "next" or "previous"; text or an image of your choice can be specified with widget arguments.

IMPORTANT: In templates which support multiple "list" widgets that can be paginated, the widget option is required to specify which listing is being controlled. This includes the Gallery List and Gallery Collection Display templates.

widget=[widget name]
Name of the widget in the current template that you want to paginate. Required in order to paginate the [[collections_galleries_list]] widget. (See example below.) 

text=[your text]
Specifies the text to use for the button. HTML is allowed. 

image=[your image URL]
Specifies the image URL to use for the button. Overrides the text option.
  • A.page_next SPAN, A.page_previous SPAN: a SPAN enclosing the hyperlinked text for the buttons.
  • NOTE: A CSS class can be used in conjunction with or as an alternative to the widget arguments to change the look and behavior of the buttons (e.g. to provide mouseover [A:hover] behavior).
[[page_next widget="collections_galleries_list" text="Next Page ->"]]

[[page_previous widget="collections_galleries_list" image="http://www.mysite.com/images/arrow-left.gif"]]
 
[[page_select]] Page Select List
Displays a HTML select list for page navigation. Note that a <FORM> element is created; to prevent extra white space around the widget, set the margins in its CSS class.

IMPORTANT: In templates which support multiple "list" widgets that can be paginated, the widget option is required to specify which listing is being controlled. This includes the Gallery List and Gallery Collection Display templates.

widget=[widget name]
Name of the widget in the current template that you want to paginate. Required in order to paginate the [[collections_galleries_list]] widget. (See example below.)
  • FORM.page_select: containing <FORM> for the select list
[[page_select widget="collections_galleries_list"]]

 
[[portfolio]] Portfolio
Displays the currently selected portfolio gallery. Gallery images are displayed in a horizontally scrolling, slideshow-like presentation using JavaScript animation.
width=[width]
Specifies the width in pixels for the portfolio. Values between "250" and "1000" are accepted. Defaults to 600 pixels. 

height=[height]
Specifies the height in pixels for the portfolio. Values between "250" and "1000" are accepted. Defaults to 75% of the portfolio width. 

twoup=[true|false]
Display consecutive vertical images as two-ups (side-by-side in a single frame) if the portfolio is sufficiently wide. Defaults to true. 

caption=[true|false]
Display a "Show Caption" link which shows the caption for the currently displayed image on mouseover. Defaults to false. 

infolink=[true|false]
Display a "More Info" link which links to the image detail page for the currently displayed image. Defaults to false. 

index=[on|off]
Display the number of the currently shown image out of the total in the portfolio gallery. Defaults to off. 

watermark=[on|off]
Watermark images to deter image theft. Defaults to on. 

navhover=[on|off]
Show navigational arrow only on hover, instead of always. Defaults to on. 

image_title=[on|off]
Show the title of image. The title is derived from the image's IPTC, or, failing that, the image's file name. Defaults to off. 

transition=[SLIDE|XFADE]
Type of transition to use when changing between images. Defaults to SLIDE.
  • SLIDE - Images slide on and off screen.
  • XFADE - Images fade-in over each other.
  • DIV.PSPortfolio A.psport_info: "More Info" A tag.
  • DIV.PSPortfolio A.psport_cap: "Show Caption" A tag.
[[portfolio width=900 height=600 caption=true]]
 
[[portfolio_link]] Portfolio Link
A conditional link to the Portfolio page. Note that the link only appears if you have at least one portfolio gallery specified. By default, the link contains the text "Portfolio"; different HTML can be specified using a widget option.
text=[your text]
Specifies the text to use for the link. HTML is allowed. 

  • A.portfolio_link
  • A.portfolio_link.portfolio_link_multi: Multi class added when multiple portfolio galeries are present.
[[portfolio_link text="My Portfolio"]]
 
[[portfolio_link_dropdown]] Drop-down Menu for Portfolio Link
A mouseover drop-down menu for [[portfolio_link]]. When the user hovers their mouse over the portfolio link, a list of all available portfolio galleries is displayed. By default, the list is absolutely positioned to appear just below the portfolio link, and an animation effect is used to show and hide the list.

Note: The [[portfolio_link]] widget is required and must be included in the template before the[[portfolio_link_dropdown]] widget.

jQuery note: This widget utilizes the jQuery JavaScript library. If you are already including a version of jQuery in your site, you may need to check for conflicts when including this widget.

fixed=true
Use fixed positioning for the menu. 

  • UL.portfolio_link_dropdown: Containing element for the portfolio menu entries. The background color for the menu should be applied here.
  • UL.portfolio_link_dropdown LI: List item element for each portfolio menu entry.
  • UL.portfolio_link_dropdown LI A: Link to each portfolio.
 
[[my_account_url]] My Account Page URL
The URL for your My Account page, where a client can view details about their account. This page is usually used as the "gateway" to other customer pages. If the user is not logged in, they will be redirected to the login page first.
 
[[my_gallery_invitations_url]] My Gallery Invitations URL
The URL for your My Gallery Invitations page, where a client can view a list of galleries that you have invited them to. If the user is not logged in, they will be redirected to the login page first.
 
[[my_downloads_url]] My downloads URL
The URL for your My Downloads page. If the user is not logged in, they will be redirected to the login page first.
 
[[my_purchases_url]] My Purchases URL
The URL for your My Purchases page. If the user is not logged in, they will be redirected to the login page first.
 
[[my_contact_info]] My Contact Information
Displays your contact information (addresses, phone numbers) as specified in your PhotoShelter User Profile. Only addresses and numbers designated as "show publicly" will be listed. 

To edit your contact info, go to your "My Account" page.
  • SPAN.my_contact_info.address: applies to address information.
  • SPAN.my_contact_info.addressname: applies to name of address. (e.g. "Home Address")
  • SPAN.my_contact_info.phone: applies to phone number information.
  • SPAN.my_contact_info.phonetype: applies to phone number type. (e.g. "Mobile")
 
[[my_links]] My Links
Displays your links as specifed in your PhotoShelter User Profile. To edit your links, go to your "My Account" page.
  • SPAN.my_links: applies to name of the link.
  • A.my_links: applies to the URL of the link.
 
[[my_name]] Name for your PhotoShelter account
Displays your name as it appears in your PhotoShelter account. In the case of a Multi-User organization, the organization name is displayed.
 
[[my_specialties]] My Specialties
Displays your specialties as specifed in your PhotoShelter User Profile. To edit your specialties, go to your "My Account" page.
 
[[num_galleries]] Total Number of Galleries
Displays the total number of gallery packages on the current page.
 
[[num_gallery_collections]] Total Number of Gallery Collections
Displays the total number of gallery collections on the current page.
 
[[num_items]] Total Number of Collections and Galleries
Displays the total number of items (collections + galleries) in the current page.
 
[[num_images]] Total Number of Images
Displays the total number of images in a gallery or search results set.
 
[[my_recent_galleries]] My Recent Galleries List
Displays a list of galleries that are listed on your site and can be seen by "Everyone," sorted most recent first. It includes galleries contained within collections that are listed on your site.
  • UL.my_recent_galleries: containing UL element for list.
 
[[referral_link_url]] Referral Link URL
A link to the PhotoShelter homepage that sets your Refer-a-Friend code in the user's browser cookie. If the user subsequently proceeds to the PhotoShelter signup page, your Refer-a-Friend code will be automatically set.
Powered by <a href="[[referral_link_url]]">PhotoShelter</a>
 
[[rss_feed_link]] RSS Feed Link
Displays an RSS icon and link to the RSS feed for the current page. By default, the link contains the text "Subscribe to RSS"; different text/HTML can be specified using a widget option.
text=[your text]
Specifies the text to use for the link. HTML is allowed. 

  • A.rss_feed_link
[[rss_feed_link text="RSS Feed"]]
 
[[rss_feed_url]] RSS Feed URL
The raw URL for the current page's RSS feed. Useful if you want full control over how you present your feed.
 
[[search_box]] Search Box
Displays a keyword search box for searching your images.
sort=[rank|date]
Specifies the sort order for the search. Defaults to "rank."
  • rank: sort by relevance
  • date: sort by date
  • SPAN.search_box: SPAN containing "Search Archive" label of the search box.
  • INPUT.search_box: INPUT field for search box.
 
[[search_box_advanced]] Advanced Search Box
Displays an advanced search form for searching your archive. By default, all available search fields are displayed; you can omit specific fields by using the "skip" option.
filename
Adds a file name search field to the search form. 

skip=[field]
Optionally skip fields in the search box. You can specify multiple fields by separating them with commas. The following fields can be skipped:
  • city
  • state
  • country
  • orientation
  • model_release
  • property_release
  • pricing
  • date
[[search_box_advanced skip="city,state,country,property_release"]]
 
[[search_box_refine]] Refine Search Box
Displays a search form for refine your search results; the form can be displayed in either a vertical column or collapsible horizontal layout. By default, all available search fields are displayed; you can omit specific fields by using the "skip" option.
style=horizontal
Display the search form as a collapsible horizontal box. 

filename
Adds a file name search field to the search form. 

skip=[field]
Optionally skip fields in the search box. You can specify multiple fields by separating them with commas. The following fields can be skipped:
  • city
  • state
  • country
  • orientation
  • model_release
  • property_release
  • pricing
[[search_box_refine skip="city,state,country,property_release"]]
 
[[search_page_url]] Advanced Search Page URL
The URL for your Advanced Search Page. Use this to create links to the Search function.
<a href="[[search_page_url]]">Search My Archive</a>
 
[[search_result_msg]] Search Results Message
Displays a message which explains the results of an image search (e.g. "Your search yielded 15 images"). When the search yields no results, a message is displayed ("Your search yielded no results. Please try broadening your search criteria."). The Advanced Search Box may also be optionally displayed using a widget option to allow the user to refine their search.
show_search_box=[yes|no]
Specifies whether to display the Advanced Search Box in the event of no search results. Default is "no."
  • DIV.search_result_msg: containing <DIV> for the search results message.
[[search_result_msg show_search_box="yes"]]
 
[[search_results_link]] Back to Search Results Link
Displays the link for returning to the Search Results page, if applicable. Use this on the Search Results Image Display page to create links back to the search results. By default, the link contains the text "Back to Search Results"; different HTML can be specified using a widget option.
text=[your text]
Specifies the text to use for the link. HTML is allowed. 

image=[your image URL]
Specifies the image URL to use for the link. Overrides the text option.
  • A.search_results_link: the <A> hyperlink tag for the link
  • NOTE: A CSS class can be used in conjunction with or as an alternative to the widget arguments to change the look and behavior of the link (e.g. to provide mouseover [A:hover] behavior).
[[search_results_link text="Go Back"]]
[[search_results_link image="http://www.mysite.com/images/back.gif"]]
 
[[search_thumbs]] Search Results Thumbnails
Displays a tiled thumbnail view of the images contained within the current search results.

The "add_to_cart_link" and "add_to_lightbox_link" options create links inside a separate DIV block at the bottom of each thumbnail LI. The DIV is assigned a CSS selector thumb_links; a default style is specified in the PhotoShelter sample CSS file included in the default Master Template:
http://www.photoshelter.com/css/custom/sample.css
size=[size]
Specifies the size in pixels for the thumbnails. Values between "50" and "200" are accepted. If no value is specified, the default thumbnail size (100 pixels) is used.

preview
Turns on the image preview when the users passes their mouse over the thumbnail.

preview_delay=[time]
Specifies the time in milliseconds before launching an image preview, if enabled. Values between 50 and 3000 are accepted. If no value is specified the default delay is 500 milliseconds (.5 seconds).

preview_zoom=[zoom]
Specifies the magnification of the existing thumbnail image in an image preview, if enabled. Values between "1" and "3" are accepted. The default zoom is "2.25".

preview_speed=[time]
Specifies the animation time in milliseconds of the image preview, if enabled. Values between "0" and "1000" are accepted, where "0" disables the animation effect. By default, animation is disabled. Specifies the animation time in milliseconds of the image preview, if enabled. Values between "1" and "1000" are accepted. The default animation speed is 100 milliseconds.

index
Display the image index number (e.g. "5.") under each thumbnail. 

iptc=[field] SEO
Display a specified IPTC field under each thumbnail. Options include:
  • caption (Gallery image caption if available; otherwise IPTC Caption)
  • title (IPTC Title)
  • headline (IPTC Headline)

iptc_length
The maximum length of the IPTC field, if displayed. Values between 10 and 255 are accepted; if the IPTC value is longer than the specified length, it will be truncated with ellipsis (...). The default length is 50 characters. 

filename SEO
Displays the image file name (e.g. "IMG4012.jpg") under each thumbnail. If the index option above is also specified, the filename will be on the same line (e.g. "5. IMG4012.jpg"). 

filename_length
The maximum length of a file name, if displayed. Values between 10 and 255 are accepted; if the file name is longer than the specified length, it will be truncated with ellipsis (...). The default length is 15 characters. 

add_to_lightbox_link=[html code]
Display an "add to lightbox" link for each thumbnail image. You may specify your own HTML code for the link as the value of the option. If no html code is specified, the default PhotoShelter "+LIGHTBOX" button will be used.

add_to_cart_link=[html code]
Display an "add to cart" link for each thumbnail image. It will only be displayed for images which are priced for sale. You may specify your own HTML code for the link as the value of the option. If no html code is specified, the default PhotoShelter "+CART" button will be used.
  • UL.thumbs.search_thumbs: Containing <UL> element for all thumbnail tiles. Each thumbnail tile is represented as a <LI> element within it.
  • UL.thumbs.search_thumbs TD.slide: TD for thumbnail image.
  • TD.search_thumbs.text: TD for text under thumbnail image (e.g. filename)
  • DIV.thumb_links: A DIV containing the add_to_cart_link and add_to_lightbox_link link options.
  • DIV.thumb_links A.thumb_links_lightboxDIV.thumb_links A.thumb_links_cart: the A tag used to link the add_to_lightbox_link and add_to_cart_link links, respectively.
[[search_thumbs index filename]]
[[search_thumbs filename add_to_lightbox_link]]
[[search_thumbs filename add_to_lightbox_link='+lightbox' add_to_cart_link='<img src="http://myserver.com/images/cart.gif" border="0">']]
 
[[search_image_filmstrip]] Search Image FilmStrip
Provides a filmstrip navigation mechanism for the single image view of a set of search results. Gives the viewer a supplemental way to scroll through images without reverting to the full thumbnail view.
size=[width]
Specifies the total width of the filmstrip object. The widget uses this number in conjunction with the thumb_cnt parameter to fit the largest possible thumbs into the specified width.

thumb_cnt=[any odd number]
Number of thumbnails to display in filmstrip. Defaults to 5, must be an odd number. 
  • DIV.gallery_image_filmstrip: Containing <div> for the filmstrip
[[gallery_image_filmstrip width=600 thumb_cnt=5]]
 
[[search_tips]] Search Tips
Displays search tips for the Search Page.
  • DIV.search_tips: containing <DIV> for the search tip
 
[[search_social]] Social Network Sharing Panel
Displays a list of options for sharing search results on social and bookmarking sites.

style=[dark]
Specifies the icon style to use. By default, icons are light gray (#AAAAAA). A "dark" style (#666666) may be specified. 

 
[[signup_form]] Signup Form
Displays the account signup form.
  • TABLE.signup_form: the table enclosing the login form fields.
  • TABLE.signup_form TH: the TH table cells enclosing the form input labels, e.g. "First Name:"
  • TABLE.signup_form TD: the TD table cells enclosing the form input text boxes
 
[[signup_page_url]] Signup Page URL
The URL for your signup page. If a user is already logged in, they will be automatically be logged out.
<a href="[[signup_page_url]]">Sign Up!</a>
 
[[subfeature_galleries]] My Subfeature Gallery List
Displays a list of Subfeatured Galleries. The list can be displayed in different styles based on the style widget option.
Uses same widget options as [[gallery_list]]
[[subfeature_galleries style=thumbs name description]]
 
[[typekit_include]] Typekit Stylesheet Include
Outputs code to enable Typekit dynamic font functionality on your site.
 
[[view_options]] View Options
Displays view options for the current page, including controls for the number of images per page. This replaces the[[display_options_link]] which is now deprecated.

The images-per-page options includes your currently selected number of images per page, as well as a "View All" option. The view all option is limited to a maximum of 500 images; if the current page contains more than 500 images, "View All" will be replaced with "500."
  • SPAN.view_options: Containing <SPAN> element for all view options DOM elements.
  • SPAN.view_options A: <A> element for selectable view options.
  • SPAN.view_options SPAN.view_options_selected: <SPAN> element for view options that are currently selected.
 

Still have questions? Contact us.

Comments

Powered by Zendesk