Adobe 65007312 Programming Guide - Page 134

Lua data types, Variable, Description

Page 134 highlights

CHAPTER 6: Writing a Web-engine Plug-in LuaPage syntax 134 Variable includeFile() Description An execution-time function that allows a page to include another file using runtime logic to specify which file. For example: My web gallery This is the grid.html file. Include a file using the include directive: Include same file using the includeFile command: Include a file that includes another file: LuaPage data types These data types are defined: imageProxy An object that has these properties: exportFilename (string) The base name string of a JPEG that will be written to disk for this photo. rating (number) The numeric rating for the image, or nil if it has no rating imageID (string) The id_global string for this image. renditions (array of object) An array of imageRendition objects for the renditions of this photo. metadata (table) A table of metadata settings, based on the perImage settings. colorLabel (string) The localized text for a photo's colorLabel, such as "red", or nil. imageRendition width height relPath dir An object that represents an image rendition for a photo. It has these properties: (number) The width in pixels. (number) The height in pixels. (array of string) An array of directory names, in which the last entry is the file name. (array of string) An array of directory names.

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204

C
HAPTER
6: Writing a Web-engine Plug-in
LuaPage syntax
134
LuaPage data types
These data types are defined:
includeFile()
An execution-time function that allows a page to include another file using
runtime logic to specify which file. For example:
<html>
<body>
<h1>My web gallery</h1>
This is the grid.html file.
<BR>
Include a file using the include directive:
<%@ include file="subdir/foo.html" %>
<BR>
Include same file using the includeFile command:
<% includeFile( 'subdir/foo.html' ) %>
<BR>
Include a file that includes another file:
<% includeFile( 'file1.html' ) %>
</body>
</html>
Variable
Description
imageProxy
An object that has these properties:
exportFilename
(string) The base name string of a JPEG that will be written to disk for this photo.
rating
(number) The numeric rating for the image, or nil if it has no rating
imageID
(string) The
id_global
string for this image.
renditions
(array of object) An array of
imageRendition
objects for the renditions of this
photo.
metadata
(table) A table of metadata settings, based on the
perImage
settings.
colorLabel
(string) The localized text for a photo’s
colorLabel
, such as "red", or nil.
imageRendition
An object that represents an image rendition for a photo. It has these
properties:
width
(number) The width in pixels.
height
(number) The height in pixels.
relPath
(array of string) An array of directory names, in which the last entry is the
file name.
dir
(array of string) An array of directory names.