...
The Third Light Browser is a tool to help integrate Third Light IMS with your CMS or web management application. It enables web developers and integrators to place a "Fetch Image From IMSThird Light" button into a CMS, mailing list manager or other web tool. Using the button, a user working in your CMS can select a file from your Intelligent Media Server Third Light and embed a URL into the web or mail page they are editing so that the file will play or display when the page is opened – without the user having to exit the CMS. As well as embedding published files, you can also edit and crop them to suit the purpose, before embedding the link.
Tip |
---|
The Third Light Browser is available from IMS v6.0.18 onwards. It is included with IMS Premium and IMS Enterprise, or can be added as a module to IMS Standard (please ask [email protected])all Chorus sites. |
Example usage
...
- For IMS v6, a simple example of how the Third Light browser can be used is included in your Third Light IMS site - visit https://your-ims-site/cmsbrowser.tlx.
- For Chorus, an equivalent example of the Third Light browser is included under https://your-chorus-site/cms.html.
To insert the Third Light browser into another site, you can use the following example code:
...
The cropChosen
event has associated details of the file selected. The callback function is passed an object containing keys as follows:
Key | Description |
---|---|
| The IMS File Third Light reference of the selected image |
| The width in pixels of the selected image |
| The height in pixels of the selected image |
| The version number of the selected image |
| A hash of details describing the selected crop area |
| The key of the crop class selected (as provided to |
| A hash containing details of the URL to the selected file (only present when |
| A hash of metadata for the selected file |
...
Key | Description |
---|---|
| IMS URL to browse - defaults to the same as that passed to the |
| A string referring to the theme to load. Currently supported options are "light", "dark" and "blue" |
| An array of hashes defining the output formats to present |
| Boolean, whether to enable the display of metadata in the CMS browser (Off by default) |
| An optional array of metadata fields to include; defaults to all |
| An optional array of hashes, describing an order and content of metadata panels to display. Defaults to the IMS configuration |
| Boolean, whether to display revisions other than the currently active one. (Off by default) |
| Boolean, whether to return a URL to the requested output file. Requires that Secure File Fetch be enabled in the IMS site, and that the user has permission to publish files. (Off by default) |
| Boolean, whether to close the widget when the selection is made. Otherwise a final page is displayed containing pertinent details. (On be default) |
| An optional session ID to use (rather than prompting the user to log in, or using their existing IMS session). This is useful in conjunction with server-side API-key session set up to allow auto-login |
| Boolean, whether to suppress the 'Close' button on the widget. (Off by default) |
showUnsuitableThumbnails | Boolean, denoting whether to show thumbnails that are unsuitable for any of the available crop classes when browsing. (Off by default) |
showUnsuitableCropClasses | Boolean, denoting whether to show unsuitable crop classes in the crop class drop-down when cropping an image. (Off by default) |
cropSnap | Integer denoting the closeness in relative pixels of a padded image to the crop border that will force a snapping of the image to that border. (30 by default, 0 will disable it) |
...
When the metadata
option is on, the CMS browser offers metadata to users. Without any further configuration, this displays the fields (and panels) configured in IMS (see Editing Metadata Fields for more information), restricted by user settings if the Multi-tenant Metadata feature is enabled.
...
Alternatively, you may specify the metadataLayout
option. This takes an array of hashes, describing the panels and fields to display - overriding panel layouts from IMS. This is formatted as follows:
...