Media Table
From DLXS Documentation
(Difference between revisions)
| Line 1: | Line 1: | ||
| - | [[DLXS Wiki|Main Page]] > [[Mounting | + | [[DLXS Wiki|Main Page]] > [[Mounting Collections: Class-specific Steps]] > [[Mounting an Image Class Collection]] > Media Table |
| + | <hr> | ||
==Introduction== | ==Introduction== | ||
Current revision
Main Page > Mounting Collections: Class-specific Steps > Mounting an Image Class Collection > Media Table
[edit] Introduction
This document defines the fixed set of fields that comprise a collection's Media Table in Image Class. As of DLXS 12, every collection must have a media table. Scripts provided with Image Class generate the Media Table automatically. See <a href="mysql.html">Image Class and MySQL</a> for instructions.
The Media Table serves two basic purposes.
- Aid the process of linking media filenames to actual media files.
- Specify the relationship among potentially numerous media files associated with a single record.
[edit] Media Table Definition
| Field | Definition | Legal Values |
|---|---|---|
| istruct_caption | Any text. | String. |
| istruct_caption_[fldabbr] | Fields mapped to ic_vi appear in the media table as istruct_caption_[fldabbr] where fldabbr is the abbreviation of the field mapped to ic_vi. Prior to DLXS 13, fields mapped to ic_vi were combined to form the istruct_caption field and were not individually represented. Now, it is possible to search, display, and sort by each field independently. | String. |
| istruct_isentryid | Entry ID. The Entry ID is an identifier for the image unique across all Image Class collections. Therefore, it should include the collid, Data Table record id, and media filename, indluding extension. | String in the form S-COLLID-X-DataTableRecordID]filename.ext (this format is required, including the square-bracket) |
| istruct_isentryidv | Essentially, an older style, deprecated, Entry ID that combines collid, record id, and a serial number for identification within the record. Included in the media_table for backward compatability. | String in the form S-COLLID-X-DataTableRecordID-Integer (hyphen delimited all the way through) |
| istruct_m | Media filename. | Any legal filename, without the path and extension. |
| istruct_me | The extension of the media filename, representing the online format. | Any legal filename extension. Dot omitted. |
| istruct_mo | The extension of the media filename, representing the master image file format. | Any legal filename extension. Dot omitted. |
| istruct_ms | Tells the status of the media file. Is it present in the system, or not. It is not uncommon for a record to include a filename for an image that is not to be accessible online. | P | N (P = present | N = not present) |
| istruct_mt | Media type. | String. Most common values are IMAGE:::DYNAMIC (MrSID file) and IMAGE:::FIXED (several sizes of JPEG). See <a href="imageloading.html">image loading documentation</a> for full range of possibitlities. |
| istruct_stid | Serial identifier of the structure. See <a href="imagestructures.html">Mapping Image Structures</a> to learn about structures. | Any integer value. In most cases, "1". |
| istruct_stty | Type of structure. Determines whether media is treated as "summary" or "detail". | summ | det |
| istruct_face | A structure sub-component. Often the presenation represented in the media. Front, Back, Top, Bottom, Inside, etc. | String. |
| istruct_x | The x coordinate of the media within the structure. | Integer |
| istruct_y | The y coordinate of the media within the structure. | Integer |
| m_caption | Image Caption. Redundant with istruct_caption. | Deprecated. Can be omitted. |
| m_entryauth | Used to decide whether the media file is restricted to authorized users, or completely unrestricted. Allows metadata and thumbnail to be world viewable, and full media file to be restricted. | WORLD | COLLID ( world = unrestricted | collid = restricted to users specifically authorized to use the collection. |
| m_fn | Media filename. Redundant with istruct_m. | Deprecated. Can be omitted. |
| m_id | The corresponding record ID from the Data Table. | String. |
| m_iid | The record ID within the Media Table. The media filename, whenever possible. | String. Must be unique within the Media Table. |
| m_searchable | Determines whether this item should be searchable and retrievable in a result set. Primarily applicable to records with multiple media files. Allows "summary" images to appear in a result set, and "detail" images to be omitted, or vice versa. | 1 | 0 |
