List of Placeholders
A placeholder is like a shortcut for using data or text from other sections of the software.
Placeholders get replaced by the content they represent. For example, a text box in the skin may contain $(p) which will display the percentage of how much the image has loaded, while $(ut) will display the Title in the User Data.
For each input field that has a corresponding placeholder, you will see a tooltip of its placeholder when the mouse hovers over the field.
Skin Editor
The following placeholders can be used in text fields, as variable values, and as logic block triggers and values. Some fields throughout the skin will have a button to expand the text box. In the expanded text box, there will be a placeholders button, where you can choose the placeholder you need.
Loading
Use the following placeholders in a text box to display the placeholder’s value.
| Placeholder | Description |
|---|---|
$(b) |
bytes loaded |
$(t) |
bytes total |
$(B) |
kilobytes loaded |
$(T) |
kilobytes total |
$(p) |
percentage loaded |
Position
You can either display the placeholders’s value in a text box or use the placeholder in an action.
| Placeholder | Description | Text Box | Action |
|---|---|---|---|
$(ap) |
current pan angle | ✓ | ✓ |
$(at) |
current tilt angle | ✓ | ✓ |
$(az) |
current zoom | ✓ | ✓ |
$(col) |
current column | ✓ | ✓ |
$(row) |
current row | ✓ | ✓ |
$(state) |
current view state | ✓ | ✓ |
$(statetitle) |
current view state title | ✓ |
$(ctitle) in the menu text box to display the individual view state titles. Use $(statetitle) in a text box to display the currently selected state.Hotspots
| Placeholder | Description | Text Box | Action |
|---|---|---|---|
$(hs) |
hotspot title | ✓ | |
$(hd) |
hotspot description | ✓ | |
$(hu) |
hotspot URL | ✓ | ✓ |
$(ht) |
hotspot target | ✓ | ✓ |
$(hc) |
custom image url – Use this placeholder as a Logic Block Trigger to change an element based on the file. For example, change the External Image Loader’s background based on the image added to the Custom Image. | ||
$(hid) |
hotspot ID | ✓ | ✓ |
$(hSid) |
hotspot skin ID | ✓ | ✓ |
$(r) |
hotspot URL – (use in conjunction with $(hu): $(r)$(hu)) Add $(r) to files, images, and PDF hotspot templates when the output will be embedded in a WordPress page as a Garden Gnome Package format. This placeholder is not needed for YouTube and Vimeo hotspot types. $(r) will be replaced by the player’s base path. |
✓ | ✓ |
Cloner
These placeholders can be used to call tags/IDs and titles in child elements of cloner types table, hotspots, and translations.
| Placeholder | Description |
|---|---|
$(ctag) |
The current tag/ID in the cloner. For a View States cloner, this is the state number. |
$(ctitle) |
The current title in the cloner. For a hotspots cloner, this is the hotspot title. For a translations cloner, this is the language name. For a view states cloner, this is the state’s title. |
Object
| Placeholder | Description |
|---|---|
$(cols) |
The number of columns in the project. |
$(rows) |
The number of rows in the project. |
$(states) |
The number of view states the project has. |
User Data
Use the following in a text box or as variable in the Skin Editor.
| Placeholder | Description |
|---|---|
$(ut) |
user data title |
$(ud) |
user data description |
$(ua) |
user data author |
$(ue) |
user data date/time |
$(uc) |
user data copyright |
$(us) |
user data source |
$(ui) |
user data information |
$(uo) |
user data comment |
File Names
The following placeholders can be used in the User Data fields and will extract data from the input file name.
Consider that the input file name is /User/Thomas/Photos/pano.jpg
| Placeholder | Description |
|---|---|
$(ib) |
image base name, pano |
$(in) |
image filename, pano.jpg |
$(id) |
image directory, Photos |
$(if) |
image absolute file name, /User/Thomas/Photos/pano.jpg |
File Paths
All of the following can be used in the output file path. All file names are written without their extensions.
| Placeholder | Description |
|---|---|
$(n) |
input image name |
$(p) |
project name |
$(d) |
project directory |
$(i) |
image directory |
$(f) |
project directory & project name (legacy) |
$(y) |
node ID – (used in the tiles file path of multi-resolution which will use the node’s ID rather than its filename) |
Multi-resolution
All multi-resolution placeholders found in the Image panel in web output are used within the Filename field for naming conventions.
All lowercase letters will begin their number sequences with zero (0). All uppercase letters will begin their sequences with one (1).
The default naming convention and organization is tiles/c%c_l%r_%y_%x.jpg.
Cube Faces
| Placeholder | Description |
|---|---|
%c |
0, 1, 2, 3, 4, 5; cf_0, cf_1, etc. |
%C |
1, 2, 3, 4, 5, 6; cf_1, cf_2, etc. |
Multi-resolution Levels
| Placeholder | Description |
|---|---|
%l |
the lowest resolution level will begin with zero (0): l_0, l_1, l_2, etc. |
%L |
the lowest resolution level will begin with one (1): l_1, l_2, l_3, etc. |
%r |
the highest resolution level will begin with zero, thus reversing the order of the levels |
Tile Positions
| Placeholder | Description |
|---|---|
%y |
tile location on the y-axis |
%x |
tile location on the x-axis |
%00Y |
tile location on the y-axis beginning with one (1) and 2 places: 001-999 |
%00X |
tile location on the x-axis beginning with one (1) and 2 places: 001-999 |