Field | Required? | Values to Enter | Remarks |
$k8ImageUUID | Yes | UUID from image | The UUID is unique in the Klixel8 universe of processed images and is used as a key ID for all things related to the image. |
$k8Parameters | No | buttons: address to use for zoom buttons buttonsDiv: div name to contain zoom buttons initialZoom: default is 1, use to load to a different amount accessibility: default is on, value of "off" turns off the features maintainAspect: default is true, chaf = false, cha=true. resizeMode: "fill" expands image to fit w or h when maintainAspect is false maxZoom: default is 12, max possible is 50 minZoom: default is 1, can equal maxZoom cbDoneLoadParams: deprecated overlays: default is none, else HTML ID, X, Y, Width, Height | Load options for setting up active image. Example: maintainAspect=false&resizeMode=fill |
$k8DivId | Yes | k81 is default | OK to use default except where two or more Active Images appear in a single web page; all same-page Active Images must have different/separate DivId's. Can be used in k8custom.js to define special behaviors Div by Div. |
$k8k8userJS | Yes | Points to required k8user.js; this defines info panel behavior. | This can be modified to point to future versions if desired. Klixel8 will leave all versions in place to ensure perpetual compatibility for deployed Active Images. |
$k8klixel8JS | Yes | Points to required klixel8.js; this defines active image behavior. | This can be modified to point to future versions if desired. Klixel8 will leave all versions in place to ensure perpetual compatibility for deployed Active Images. |
$k8DataJson: | Yes | Points to JSON file that contains info panel metadata | Modifications to the Builder elements are saved in this file. |
$k8BaseContentUrl | No | Defaults to Klixel8 Amazon S3 location. | Use to point to customer specified file location in case the customer needs to host tile files etc on own server |
$k8PageTitle | Yes | As desired. | Fills the browser tab and HTML metatag for "title". |
$k8ButtonsAddress | No | Defaults to the Klixel8 S3 folder. Path to alternative button files may be specified here. | Original Open Sea Dragon buttons are the default. |
$k8ButtonsDiv | No | Default: Buttons nested in the upper right corner of the Active Image. Specify alternative location using the div ID of HTML Div on the page that will contain the buttons. | This specifies where in the loaded image that the buttons appear, i.e., upper right, lower right, bottom middle, etc. |
$k8MP4VideoFile | No | URL to .mp4 file; can be absolute or relative. eg. images/xyz.mp4 | Enter ONLY an .mp4 OR a Youtube video URL. The video loads, plays, and fades out, immediately followed by the Active Image fading in. |
$k8YouTubeVideoAddress | No | URL for desired Youtube video, e.g.: https://www.youtube.com/watch?v=FkhWZNoesUw | Enter ONLY an .mp4 OR a Youtube video URL. The video loads, plays, and fades out, immediately followed by the Active Image fading in. |
$k8LoadLogo | No | URL to image to fade in/out after active image load | The logo fades in immediately following Active Image load, shows briefly, then fades out. Can be .jpg or .png format. |
$k8LoadText | No | String that fades in/out after active image load; only triggered by a video having completed. | Formatted according to user.css file settings |
$k8Fonts | No | Deprecated | Fonts are handled in CSS. |
$k8MetaNameDescription | No | As desired | meta name="description" |
$k8MetaItemPropName | No | As desired | meta itemprop="name" (Schema.org markup for Google+) |
$k8MetaPropertyOgTitle | No | As desired | meta property="og:title" |
$k8MetaNameTwitterTitle | No | As desired | meta name="twitter:title" (Twitter Card data) |
$k8MetaItemPropDescription | No | As desired | meta itemprop="description" (Schema.org markup for Google+) |
$k8MetaNameTwitterDescription | No | As desired | meta name="twitter:description" (Twitter Card data -Description here less than 200 characters) |
$k8MetaPropertyOgDescription | No | As desired | og:description |
$k8MetaNameTwitterSite | No | As desired | meta name="twitter:site" (Twitter Card data: @publisher_handle) |
$k8MetaPropertyOgSiteName | No | As desired | meta property="og:site_name (Facebook Open Graph data) |
Template Reference Sheet - index.php Details Print
Created by: Timothy Thorsen
Modified on: Thu, 3 May, 2018 at 1:21 PM
Did you find it helpful? Yes No
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.