HTML Tokens

Top  Previous  Next

Tokens enclosed by '@' characters are filled in when the HTML pages are generated e.g. @exif@ is replaced with the full EXIF details for the image. The tables below give a list of the tokens used:

 

URLs and file information

 

@firstURL@

The URL of the first full size page e.g. img_0001.htm

@lastURL@

The URL of the last full size page e.g. img_0100.htm

@next@

The word "Next" with a hyperlink to the next fullsize page unless this is the last page. e.g. <a href="img_0999.htm">Next</a> Notes: The word used defaults to "Next" but can be edited in Preferences. Use @next2@ and @next3@ to reference pages generated from fullsize2_template.{ext} and fullsize3_template.{ext}

@nextURL@

The URL of the next fullsize page e.g. img_0100.htm (empty for the last image)

@nextIcon@

Inserts an image called next.gif with a hyperlink to the next fullsize page unless this is the last page. e.g. <a href="img_0999.htm"><img src="next.gif" alt="Next" title="Next" border="0"></a> Notes: The word used in the img alt and title properties is the same as used in @next@. Use @nextIcon2@ and @nextIcon3@ to reference pages generated from fullsize2_template.{ext} and fullsize3_template.{ext}

@nextImage@

The URL of the next fullsize image. This can be used to "pre-load" the next image by including the line <img src=@nextImage@ width="1" height="1"> in the fullsize template.

@prevImage@

The URL of the previous fullsize image. This can be used to "pre-load" the previous image by including the line <img src=@prevImage@ width="1" height="1"> in the fullsize template.

@firstImage@

The URL of the first fullsize image in the gallery

@prev@

The word "Prev" with a hyperlink to the previous fullsize page unless this is the first page. e.g. <a href="img_0100.htm">Prev</a> Notes: The word used defaults to "Prev" but can be edited in Preferences. Use @prev2@ and @prev3@ to reference pages generated from fullsize2_template.{ext} and fullsize3_template.{ext}

@prevURL@

The URL of the previous fullsize page e.g. img_0100.htm (empty for the first image)

@prevIcon@

Inserts an image called prev.gif with a hyperlink to the previous fullsize page unless this is the last page. e.g. <a href="img_0999.htm"><img src="prev.gif" alt="Prev" title="Prev" border="0"></a> Notes: The word used in the img alt and title properties is the same as used in @prev@. Use @prevIcon2@ and @prevIcon3@ to reference pages generated from fullsize2_template.{ext} and fullsize3_template.{ext}

@url@

The URL of the current fullsize page created from fullsize_template.{ext} (used to link thumbnails to the fullsize page) Note: Use 2@url@ and 3@url@ to reference pages generated from fullsize2_template.{ext} and fullsize3_template.{ext}

@homeURL@

The value of "Home page" entered in Preferences e.g. http://www.breezesys.com

@body@

Concatenation of all the thumbnail images from thumbnail_template.{ext} (used in index pages)

@body2@

Concatenation of all the thumbnail images from thumbnail2_template.{ext} (used in index pages)

@body3@

Concatenation of all the thumbnail images from thumbnail3_template.{ext} (used in index pages)

@file@

The filename of the original image file e.g. CRW_0123.crw

@fileLower@

The filename of the original image file in lower case e.g. crw_0123.crw

@fileAsURL@

The filename of the original image file encoded so that it can be used in a URL e.g. Strange name%.jpg becomes Strange%20name%25.jpg

@fileNoExt@

The filename of the original image file without its extension e.g. CRW_0123

@fileNoExtLower@

The filename of the original image file without its extension in lower case e.g. crw_0123

@fileAsNumber@

Evaluates to the first group of numbers in the filename. Useful if filenames contain a reference number for identification purposes. e.g. CRW_012345_20020527.CRW would give 012345

@fileAsNumber2@

Evaluates to the last group of numbers in the filename. Useful if filenames contain a reference number for identification purposes. e.g. CRW_012345_20020527.CRW would give 20020527

@dirName@

The name of the directory where the original image file was when the HTML pages were generated e.g. 2004_May for images stored in D:\MyPhotos\2004_May\

@dir@

The full pathname of the directory where the original image file was when the HTML pages were generated e.g. D:\MyPhotos\2004_May\

@dirEscaped@

The full pathname of the directory where the original image file was when the HTML pages were generated with backslash characters escaped so that it can be used for strings within Javascript and other scripting languages e.g. D:\MyPhotos\2004_May\ becomes D:\\MyPhotos\\2004_May\\

@dirSlash@

The full pathname of the directory where the original image file was when the HTML pages were generated with \ characters converted to / to avoid problems with quoted strings in scripts e.g. D:/MyPhotos/2004_May/

@baseDirPath@

Relative path to the first HTML directory when recursively scanning subfolders e.g. ../../..

@imageNumber@

Image number within the directory. Useful for displaying text like "Image 1 of 10"

@numberOfImages@

The number of images in the directory. Useful for displaying text like "Image 1 of 10"

@fileSize@

File size of source image e.g. 3,689Kb

@fileSizeInBytes@

File size of source image in bytes e.g. 3,735,271

@fileSizePlain@

File size of source image in bytes without thousands separators e.g. 3735271

@mainFileSize@

File size of main gallery image e.g. 3,689Kb

@mainFileSizeInBytes@

File size of main gallery image in bytes e.g. 3,735,271

@mainFileSizePlain@

File size of main gallery image in bytes without thousands separators e.g. 3735271

@tagged@

Set to 1 if the image is tagged, 0 if not. Note: @tagged@ is not set in sub directories when using recursive HTML generation.

@numTagged@

The number of tagged images in the directory.

@numRanked1@

The number of images ranked 1 in the directory

@numRanked2@

The number of images ranked 2 in the directory

@numRanked3@

The number of images ranked 3 in the directory

@numRanked4@

The number of images ranked 4 in the directory

@numRanked5@

The number of images ranked 5 in the directory

@AdobeRating@

Adobe Bridge image rating as read from the XMP data

@AdobeLabel@

Adobe Bridge image label as read from the XMP data

@tableRow@

@tableRow2@

...

@tableRow10@

 

A special set of tokens to help construct HTML tables without having to use Javascript (please see the proofs template for an example of how to use this token). @tableRow<n>@ evaluates to </tr><tr> every n thumbnail images and to an empty string otherwise.

e.g. @tableRow2@ evaluates to:

1st image:

2nd image: </tr><tr>

3rd image:

4th image: </tr><tr>

@tableRow@ is treated the same as @tableRow4@.

@lastUpdatedDate@

Today's date formatted according to your locale e.g. 14 November 2008

@empty@

Always returns an empty string

       

 

Image properties and page title

 

@image@

URL of the JPEG image e.g. img_0001_std.jpg in fullsize_template and img_0001_tn.jpg in thumbnail_template

@width@

Width of the JPEG image in pixels

@height@

Height of the JPEG image in pixels

@aspectRatio@

Aspect ratio of the image calculated by dividing the height by the width and normalizing so that the value is always greater than or equal to one e.g. a 6x4 and a 4x6 image will both give a value of 1.5. The value is displayed to a precision of two decimal places with trailing 0's removed.

@aspectRatio2@

Same as @aspectRatio@ above but without the trailing 0's removed e.g. 1.50 for a 6x4 image

@orientation@

Image orientation based on image width and height e.g. "Landscape" if width >= height, "Portrait" if width < height

@main_image@

URL of the JPEG used for the main image e.g. img_0001_std.jpg

@main_width@

Width of the main JPEG image in pixels

@main_height@

Height of the main JPEG image in pixels

@thumbnail_image@

URL of the JPEG used for the thumbnail image e.g. img_0001_tn.jpg

@thumbnail_width@

Width of the thumbnail JPEG image in pixels

@thumbnail_height@

Height of the thumbnail JPEG image in pixels

@src_width@

Width of the original image in pixels

@src_height@

Height of the original image in pixels

@maxWidth@

The maximum width of the main image entered in the HTML dialog

@maxHeight@

The maximum height of the main image entered in the HTML dialog

@maxThumbWidth@

The maximum width of the thumbnail image entered in the HTML dialog

@maxThumbHeight@

The maximum height of the thumbnail image entered in the HTML dialog

@title@

The title you entered in the HTML dialog. You may use a token here e.g. if you enter @caption@ the value of @caption@ from the last image processed will be used for the title.

@rawTitle@

The title you entered in the HTML dialog without modification. Use this instead of @title@ if you want to embed HTML formatting in your title.

@strippedTitle@

The title you entered in the HTML dialog with any HTML tags removed and and special HTML characters escaped where necessary.

@user1@, @user2@ and @user3@

The value entered in the @user1@ user defined field in the HTML dialog. @user1@ is processed first and can be used to hold information for other tokens. e.g. Adding @tableRow@user1@@ to a template allows the number of thumbnails per row to be defined by the user in the HTML dialog

@encodedUser1@, @encodedUser2@ and @encodedUser3@

As @user1@ except characters like ", < and > are quoted (i.e. " becomes &quot; < becomes &lt; and > becomes &gt;).

@strippedUser1@, @strippedUser2@ and @strippedUser3@

As @user1@ except any HTML tags are removed and special HTML characters are escaped where necessary

       

 

EXIF information

 

@exif@

Full EXIF details for the image. Note: line breaks are converted to <br />

@exifSummary@

Abbreviated EXIF details for the image. Note: line breaks are converted to <br />

@caption@

The comments stored with the image. Note: line breaks in the comment are converted to <br /> Note: This is the IPTC caption if "Use IPTC caption in preference to EXIF comments" is set in preferences

@rawCaption@

The comments stored in the image without modification. Use this instead of @caption@ if you want to embed HTML formatting in your comments. Note: This is the IPTC caption if "Use IPTC caption in preference to EXIF comments" is set in preferences

@strippedCaption@

The comments stored in the image with any HTML tags removed and special HTML characters escaped where necessary. Note: This is the IPTC caption if "Use IPTC caption in preference to EXIF comments" is set in preferences

@exifComments@

The comments stored with the image. Note: line breaks in the comment are converted to <br />

@rawExifComments@

The comments stored in the image without modification.

@strippedExifComments@

The comments stored in the image with any HTML tags removed and special HTML characters escaped where necessary.

@owner@

The owner string stored in the EXIF data

@strippedOwner@

The owner string stored in the EXIF data with any HTML tags removed

@copyright@

Copyright string

@imageCounter@

Image sequence number (only available with some Canon 1D series DSLRs and Nikon DSLRs from the D70 onwards)

@imageCounter5@

Same as @imageCounter@ but padded with leading zeroes to give a 5-digit number e.g. 00123

@imageCounter6@

Same as @imageCounter@ but padded with leading zeroes to give a 6-digit number e.g. 000123

@model@

Camera model name e.g. Canon EOS 20D

@iso@

ISO setting e.g. 100

@shutter@

Shutter speed e.g. 1/125

@aperture@

Aperture e.g. 11

@EV@

Exposure value calculated using the shutter speed, aperture and ISO to nearest integer

@EV1@

Same as @EV@ except returns the value to one decimal place

@exposureMode@

Exposure mode e.g. Manual

@meteringMode@

Metering mode e.g. "Evaluative"

@flash@

Flash setting e.g. "External E-TTL"

@whiteBalance@

White balance setting e.g "Auto"

@exposureCompensation@

Exposure compensation e.g. "+1/3"

@flashCompensation@

Flash exposure compensation e.g. "-1 2/3"

@aebExpCompensation@

Auto exposure bracketing exposure compensation e.g. "+1/3"

@aebShotNumber@

Auto exposure bracketing sequence shot number

@totalExposureCompensation@

Total exposure compensation i.e. exposure compensation + AEB compensation

@lens@

Lens focal length range in mm e.g. 24 to 85

@lens2@

Alternative form for lens focal length range r.g. 24-85

@focalLength@

Focal length used for the photo e.g. 50.0

@digitalZoom@

Digital zoom (empty if no digital zoom was applied) e.g. 3x

@microAdjust@

Lens AF micro adjustment value (recent, mid to high end Canon DSLRs only)

@focusPoint@

AF focus point used e.g. "[Center]"

@focusMode@

AF focus mode e.g. "One-shot AF"

@driveMode@

Drive mode e.g. "Continuous"

@quality@

Image quality e.g. "Raw"

@colorProfile@

Name of the color profile embedded in the image.

@saturation@

Saturation setting e.g. "Normal"

@contrast@

Contrast setting e.g. "Low"

@sharpness@

Sharpness setting e.g. "Low"

@subjectDistance@

Subject distance in meters. Note: This is not always available or particularly accurate

@year@

The year the photo was taken e.g. 2005

@month@

The month the photo was taken e.g. 06 for June

@monthName@

The name of the month the photo was taken e.g. June

@day@

The day of the month the photo was taken e.g. 07

@weekday@

The day of the week the photo was taken e.g. Monday

@time@

The time the photo was taken e.g. 10:23:35

@hour@

The hour the photo was taken (00 to 23) e.g. 13 for a photo taken at 1:23:35pm

@hour12@

The hour the photo was taken (12 hour clock) e.g. 01 for a photo taken at 1:23:35pm

@hour12a@

The hour the photo was taken (12 hour clock with leading zeroes removed) e.g. 1 for a photo taken at 1:23:35pm

@ampm@

AM for photos taken between 00:00:00 and 11:59:59 or PM for photos taken between 12:00:00 and 23:59:59

@minute@

The minute the photo was taken (00 to 59) e.g. 23 for a photo taken at 10:23:35

@second@

The second the photo was taken (00 to 59) e.g. 35 for a photo taken at 10:23:35

@date@

The date the photo was taken formatted to your locale e.g. 15 June 2005

@dateTime@

The date and time the photo was taken formatted as YYYY.MM.DD hh:mm:ss

@subsecTime@

Sub-second time the photo was taken. This is the time the photo was taken to 1/100th sec and is only currently stored in the EXIF shooting data by Nikon DSLRs. Returns "00" if not defined in the shooting data.

@seqNumber@

Canon 7-digit sequence number in the form dddnnnn where ddd is the original image folder number and dddd is the image number (only valid for PowerShot cameras and some EOS cameras)

@bodyID@

Camera body id or serial number (Canon EOS cameras only)

@firmware@

Camera firmware version

@EFguideNumber@

Measure of flash power (only valid for Canon PowerShot cameras)

@selfTimer@

Number of seconds the self-timer was set for (Canon cameras only)

@macro@

Lens macro setting (only valid for some camera models)

@latitude@

GPS latitude expressed in degrees, minutes and seconds

@longitude@

GPS longitude expressed in degrees, minutes and seconds

@altitude@

GPS altitude

@latitudeAsDecimal@

GPS latitude expressed as a decimal number as opposed to degrees, minutes and seconds

@longitudeAsDecimal@

GPS longitude expressed as a decimal number as opposed to degrees, minutes and seconds

       

 

IPTC Data

 

@IPTC@

Summary of IPTC data

@IPTC_documentTitle@

Document title (IIM name: object name)

@IPTC_objectName@

same as @IPTC_documentTitle@

@IPTC_category@

category

@IPTC_supplementalCategories@

Comma separated list of supplemental categories

@IPTC_keywords@

Comma separated list of IPTC keywords

@IPTC_scenes@

Comma separated list of IPTC scenes

@IPTC_subjectCodes@

Comma separated list of IPTC subject codes

@IPTC_instructions@

instructions (IIM name: special instructions)

@IPTC_specialInstructions@

same as @IPTC_instructions@

@IPTC_dateCreated@

date created

@IPTC_timeCreated@

time created

@IPTC_releaseDate@

release date

@IPTC_releaseTime@

release time

@IPTC_author@

Author (IIM name: byline)

@IPTC_byline@

same as @IPTC_author@

@IPTC_authorTitle@

Author title (IIM name: byline title)

@IPTC_bylineTitle@

same as @IPTC_authorTitle@

@IPTC_city@

city

@IPTC_location@

location (IIM name: location)

@IPTC_sublocation@

same as @IPTC_location@

@IPTC_state@

state

@IPTC_country@

country

@IPTC_countryCode@

3-letter country code

@IPTC_contactAddress@

contact address

@IPTC_contactCity@

contact city

@IPTC_contactState@

contact state

@IPTC_contactPostalCode@

contact postal code

@IPTC_contactCountry@

contact country

@IPTC_contactPhones@

contact phones

@IPTC_contactEmails@

contact emails

@IPTC_contactWebsites@

contact websites

@IPTC_transmissionRef@

transmission reference (IIM name: original transmission reference)

@IPTC_origTransRef@

same as @IPTC_transmissionRef@

@IPTC_headline@

headline

@IPTC_provider@

provider (IIM name: credit)

@IPTC_credit@

same as @IPTC_provider@

@IPTC_source@

source

@IPTC_copyrightStatus@

copyright status - Unknown, Copyrighted or Public Domain

@IPTC_copyrightURL@

copyright info URL

@IPTC_copyrightNotice@

copyright notice (IIM name: copyright)

@IPTC_copyright@

same as @IPTC_copyrightNotice@

@IPTC_rightsUsage@

rights usage terms

@IPTC_description@

description (IIM name: caption)

@IPTC_caption@

same as @IPTC_description@

@IPTC_descriptionWriter@

description writer (IIM name: caption writer)

@IPTC_captionWriter@

same as @IPTC_descriptionWriter@

@IPTC_editStatus@

edit status

@IPTC_originatingProgram@

originating program

@IPTC_jobID@

job identifier

@IPTC_objectCycle@

object cycle

@IPTC_genre@

intellectual genre

@IPTC_urgency@

urgency (IIM name: priority)

@IPTC_priority@

same as @IPTC_urgency@

 

"stripped" versions of the IPTC tokens are available by prefixing "IPTC" with "stripped" e.g. the stripped version of @IPTC_caption@ is @strippedIPTC_caption@. The stripped versions have any HTML tags removed and special HTML characters escaped where necessary. "raw" versions of the IPTC tokens are available by prefixing "IPTC" with "raw" and these copy the IPTC data without modifying it in any way. This is useful if you wish to include URLs or HTML formatting in the IPTC data.

 

Legacy IPTC IIM data

Note: These tokens are provided for backwards compatibility with the older IPTC IIM standard and  will be empty if the image does not contain IPTC IIM data

 

@IPTC_IIM_objectName@

object name

@IPTC_IIM_category@

category

@IPTC_IIM_supplementalCategories@

Comma separated list of supplemental categories

@IPTC_IIM_keywords@

Comma separated list of IPTC keywords

@IPTC_IIM_specialInstructions@

special instructions

@IPTC_IIM_dateCreated@

date created

@IPTC_IIM_timeCreated@

time created

@IPTC_IIM_releaseDate@

release date

@IPTC_IIM_releaseTime@

release time

@IPTC_IIM_byline@

byline

@IPTC_IIM_bylineTitle@

byline title

@IPTC_IIM_city@

city

@IPTC_IIM_sublocation@

sublocation

@IPTC_IIM_country@

country

@IPTC_IIM_countryCode@

3-letter country code

@IPTC_IIM_origTransRef@

original transmission reference

@IPTC_IIM_headline@

headline

@IPTC_IIM_credit@

credit

@IPTC_IIM_source@

source

@IPTC_IIM_copyright@

copyright

@IPTC_IIM_caption@

caption

@IPTC_IIM_captionWriter@

caption writer

@IPTC_IIM_editStatus@

edit status

@IPTC_IIM_originatingProgram@

originating program

@IPTC_IIM_jobID@

job identifier

@IPTC_IIM_objectCycle@

object cycle

@IPTC_IIM_priority@

urgency

 

       

Tokens for modifying strings

 

The tokens below can be used to modify tokens or strings:

 

Token

Description

Example

{left,n,str}

Extracts the first n characters from str (which can be a string or token).

{left,4,@model@} for an image taken with a Nikon D300 will give: Niko

{mid,n,m,str}

Extracts m characters starting from the n'th character from str (which can be a string or token).

{right,1,4,@model@} for an image taken with a Nikon D300 will give: ikon

{right,n,str}

Extracts the last n characters from str (which can be a string or token).

{right,3,@model@} for an image taken with a Nikon D300 will give: 300

{first,str}

Extracts the first word from str (which can be a string or  token).

{first,@model@} for an image taken with a Nikon D300 will give: Nikon

{last,str}

Extracts the last word from str (which can be a string or token).

{last,@model@} for an image taken with a Nikon D300 will give: D300

{default,str1,str2}

Returns str1 unless it is an empty string in which case it returns str2 (str1 and str2 can be strings or tokens)

{default,1,2} returns 1
{default,,2} returns 2

{if,test,str1,str2}

Returns str1 if test is not an empty string else returns str2 (test, str1 and str2 can be strings or tokens)

{if,1,2,3} returns 2
{if,,2,3} returns 3

{upper,str}

Converts str to upper case

{upper,@monthName@} for a photo taken in June gives: JUNE

{lower,str}

Converts str to lower case

{upper,@monthName@} for a photo taken in June gives: june

{capitalize,str}

Converts str to lower case and capitalizes the first letter

{capitalize,john} gives John

 

 

Tokens for country codes and names

 

The tokens below can be used to convert between ISO-3166 two character and three character codes and to lookup country names using the two character or three character country code:

 

Token

Description

Example

{cc1,str}

Lookup the country name where 'str' is a two or three character ISO-3166 country code

{cc1,GB} gives "United Kingdom", {cc1,DEU} gives "Germany", {cc1,USA} gives "United States"

{cc2,str}

Lookup the ISO-3166 two character code where 'str' is a three character ISO-3166 country code

{cc2,GBR} gives GB, {cc2,DEU} gives DE, {cc2,USA} gives US

{cc3,str}

Lookup the ISO-3166 three character code where 'str' is a two character ISO-3166 country code

{cc3,GB} gives GBR, {cc2,DE} gives DEU, {cc3,US} gives USA

 

 

Notes

 

1.The sequence (c) is converted to ©.
2.Page and image filenames are all converted to lower case so that they don't confuse MS Front Page (unless this option is disabled in Preferences).
3.IPTC XMP fields which are the same as legacy IPTC IIM fields but have different names are listed with the IIM name in brackets e.g. @IPTC_urgency@, XMP name: urgency, IIM name: priority