1.2.2 • Published 7 years ago
itr-urls v1.2.2
ITR Urls Specification
Specification for duck-typing urls.json files
Overview
Urls file
{
/**
* Main data container property.
*/
"urls": [
/**
* Tab object
*/
{
/**
* Unique UUID for the specific tab.
* Generated with the uuid package.
*/
"id": "string",
/**
* Type id for tab type.
* type: string
*/
"typeid": "string",
/**
* Interval in seconds for the related
* tab objects to be displayed.
* type: number
*/
"interval": 10,
/**
* Coerced to Bool. Whether the related tabs should refresh upon being
* displayed.
* type: boolean
*/
"refresh": true,
/**
* Container for properties related to web type (generic web URL).
*/
"web": {
/**
* URL pointing to the WWW resource to display.
* type: string
*/
"url": "string"
},
/**
* Container for properties related to vid type (video).
*/
"vid": {
/**
* URL pointing to the video file.
* type: string
*/
"url": "string"
},
/**
* Container for properties related to ppt type (PowerPoint).
*/
"ppt": {
/**
* URL pointing to the file containing URLs for each slide in the
* PowerPoint presentation.
* type: string
*/
"slidesFile": "string"
},
/**
* Container for properties related to img type (image series)
*/
"img": {
/**
* URL pointing to the file containing URLs for each image in the
* image series.
* type: string
*/
"slidesFile": "string"
}
}
]
}
Types
Currently, there are 4 tab types:
web
Used for general web pages and resources that do not fit into the other types.
- Requires a URL. Is directly iframed from that URL.
- Interval defines display-time for this specific resource.
- Refresh reloads the resource from browser-cache.
"web": {
"url": "string"
}
vid
Used for online available video files to be played through the video player.
- Requires a URL pointing to the video file. Is played through the video player from that URL.
- Interval defines display-time for this specific video. Does not correlate with video playtime.
- Refresh is unavailable for video type.
"vid": {
"url": "string"
}
ppt
Used for Microsoft Office 2003 (.ppt) and Microsoft Office 2011 (.pptx) PowerPoint presentations that have been converted to images through the PowerPoint converter (not available online).
- Requires a URL pointing to the text file left by the converted containing URLs for each presentation slide. Each slide is then treated separately as a web type tab.
- Interval defines display-time for each slide, making the presentation take
interval * n
(wheren
is the number of slides) seconds to cycle through all slides. - Refresh reloads each slide from browser-cache.
"ppt": {
"slidesFile": "string"
}
img
Used for a series of images to be displayed in succession.
- Requires a URL pointing to the text file containing the URLs for each image. Each image is then treated separately as a web type tab.
- Interval defines display-time for each image, making the series take
interval * n
(wheren
is the number of images) seconds to cycle through all images. - Refresh reloads each image from browser-cache.
"img": {
"slidesFile": "string"
}