Specific Macro Parameters

Offset

n [Integer]

Use the Offset to specify the starting number for the sequence

If omitted, then 1 is used as the offset

%FileName %ImageNumber{offset=999}.%FileExtension

test 1000.jpg

test 1001.jpg

test 1002.jpg

Increment

n [Integer]

Specify the number by which to increment the sequence.

If omitted, then 1 is used as the increment value

%FileName %ImageNumber{increment=2}.%FileExtension

test 2.jpg

test 4.jpg

test 6.jpg

Skip

S [String]

Use this parameter if you want to keep the number the same (not incremented) for a specific condition.

Possible values are:

To skip renaming files with the same file name then use:

JD_%ImageNumber{increment=1;skip=SAMEFILENAME}.%FileExtension

Sample:

Length

n [Integer]

Specify the number length that should be used for the sequence number

For numbers smaller than the specified length it will be padded at the front with zeros

%FileName %ImageNumber{length=3}.%FileExtension

test 001.jpg

test 002.jpg

test 003.jpg

Leader

c [Character]

Specify the leader character to use for padding to the specified Length

%ImageNumber{length=5;leader=0}

00001

00002

%ImageNumber{length=5;leader=x}

xxxx1

xxxx2

Continuous

Use this parameter if you want to use a continuous number which is persistent between invocations.

In other words, Photo Supreme will continue from the last number used.

%FileName %ImageNumber{increment=2;continous;length=3}.%FileExtension

If the last number was 3, the next number will follow it:

test 004.jpg

test 006.jpg

test 008.jpg

Reset

s [String]

Use this parameter if you want the sequence to restart at a certain point while running the rename operation on a batch of images.

Possible values are:

To reset the counter after 10 passes (processing 10 images) then use:

%FileName %ImageNumber{offset=0;increment=1;reset=passes,10}.%FileExtension

To reset the counter after the number exceeds 9999, use:

%FileName %ImageNumber{offset=1;increment=1;reset=number,9999;length=4}.%FileExtension

ID

s [Constant]

By specifying an ID for the ImageNumber macro you can create different ImageNumbers, each identified by their ID. Continuous numbers for instance will count within the ID domain. It’s also possible to use different IDs based on other Macro Commands. You could, for example, create a separate numbering sequence for each file extension by using an ImageNumber with an ID specified as %FileExtension

%ImageNumber{{ID=JPG}

Separator

s [String]

Use this parameter to specify a different separator between labels in the list. By default, the elements are separated with a comma+space

Note: you cannot use the semi-colon as a separator because Photo Supreme reserves the semicolon as the separator for macro parameters.

%CatalogLabelList{separator=#}

Label 1#Label 2#Label 3

%CatalogLabelList{separator= | }

Label 1 | Label 2 | Label 3

Sort

s [String]

By default, the list will be sorted by the label name. With this parameter you can gain some control over the sort order of the elements.

Valid options are:

Name -> sort by the label name

Path -> sort by the full path

GEO -> sort by the location on the globe map

%CatalogLabelList{sort=Path}

FullPath

s [String]

When this parameter is specified, Photo Supreme returns the fully qualified path to each label. Optionally specify the separator to be used as the path separator (default path separator = ::)

%CatalogLabelList{FullPath}

Returns: People::Family::John

%CatalogLabelList{FullPath=.}

Returns: People.Family.John

Referred

You can combine this parameter with FullPath. If FullPath is not used, then this parameter is ignored.

When using referred FullPath then the hierarchical path to the catalog label will be listed after the label name instead of in front of the label name.

%CatalogLabelList{FullPath;Referred}

Returns: John (People::Family)

MaxResults

n [Integer]

Specify the maximum number of labels to return. If more labels are assigned, then those will not be returned.

%CatalogLabelList{MaxResults=1}

Parent

S [String]

When specified, then only labels that are in the hierarchy below the specified parent will be returned. Specify the name of either a Category or a Catalog Label

%CatalogLabelList{Parent=People}

This returns only catalog labels from the People category.

Separator

s [String]

Use the separator to use a different separator in between each collection in the list. By default, the elements are separated with a comma+space

Note: you cannot use the semi-colon as a separator because Photo Supreme reserves the semicolon as the separator for macro parameters.

%CatalogPortfolioList{separator=#}

Collection 1# Collection 2# Collection 3

%CatalogPortfolioList{separator= | }

Collection 1 | Collection 2 | Collection 3

FullPath

s [String]

When this parameter is specified, Photo Supreme returns the fully qualified path to each collection. Optionally specify the separator to be used as the path separator (default path separator = ::)

%CatalogPortfolioList{FullPath}

Returns: Cars.Classics.Honda

% CatalogPortfolioList {FullPath=::}

Returns: Cars::Classics::Honda

Referred

You can combine this parameter with FullPath. If FullPath is not used, then this parameter is ignored.

When using referred FullPath then the hierarchical path to the portfolio collection will be listed after the label name instead of in front of the label name.

%CatalogPortfolioList{FullPath;Referred}

Returns: Honda (Cars::Classics)