@codes in snippets


Applies to: IOS


Overview

Snippets have been important part of IOS3 since the outset enabling the photographer to display messages and banners on their site. Furthermore, the ability to make snippets 'conditional' means different snippets can be displayed in different circumstances.

In 2021, snippets became even more powerful with the ability to dynamically display variable data in snippets via @codes. This document lists some of the @codes available. It will be updated as more variable data is supported.

Shoot level data

The following @codes display information about the current access key (shoot key)

To display the: Use @code Example/Comment
access key
@shootkey

the type of key
@shoottype
subject/family/folder/job
the shootname
@shootname
the 'friendly' version of the subject/family/folder/job name

Job level data

The following @codes display information about the current job.

To display the: Use @code Example/Comment
job name
@job.jobname

friendly job name
@job.friendlyname
the friendly name as set in tsIOS at upload
job key
@job.jobkey

job tags
@job.jobtags

value of a job field
@job.jobvalue.jobfieldname
eg @job.jobvalue.schoolname
season code
@job.seasoncode

season description
@job.seasondescription

workspace code
@job.workspacecode

workspace description
@job.workspacedescription

account code
@job.accountdcode

account description
@job.accountdescription

provider code
@job.providercode

provider name
@job.providername

job expiry date
@job.expiresdate
the optional expiry date set in tsIOS
job expiry countdown
@job.expiresin.expressive.days days,
@job.expiresin.expressive.hours hours,
@job.expiresin.expressive.minutes minutes
eg 44 days, 13 hours, 24 minutes

Subject data

When the current shoot key (access key) is a subject key, the following codes can be used to retrieve subject data

To display the: Use @code Example/Comment
firstname
@shootvalue.firstname

lastname
@shootvalue.lastname

ID
@shootvalue.id

subject fields
@shootvalue.fieldname
eg @shootvalue.homeroom
home folder
@folder.name

folder key
@folder.folderkey

folder tags
@folder.foldertags

folder fields
@folder.foldervalue.fieldname
eg @folder.foldervalue.teacher
family name
@family.name

family key
@family.folderkey

family tags
@family.familytags

Identify ordering

With identify the following @codes can be used

To display the: Use @code Example/Comment
firstname
@identify.subject.firstname

folder
@identify.subject.folder

family
@identify.family.name

family members
@identify.family.members

contact name
@identify.contact.name

contact phone
@identify.contact.phone

contact email @identify.contact.email

End of article


Recent Discussions

24 May, 2022 01:08 AM
03 Feb, 2022 01:57 PM
29 Aug, 2021 08:54 AM
29 Aug, 2021 08:49 AM
17 May, 2021 11:30 AM