231 lines
10 KiB
HTML
231 lines
10 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>OTS Signs Command Center Documentation</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
|
|
<!-- favicon -->
|
|
<link href="../img/favicon.ico" rel="shortcut icon"/>
|
|
|
|
<!-- Bootstrap -->
|
|
<link href="../vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet" media="screen">
|
|
|
|
<!-- Stylesheets -->
|
|
<link href="../manual.css" rel="stylesheet" media="screen">
|
|
|
|
<!-- META -->
|
|
<meta name="keywords" content="digital signage, signage, narrow-casting, ots-signs, open source, agpl, documentation" />
|
|
<meta name="description" content="OTS Signs Command Center is an open source digital signage solution. It supports all main media types and can be interfaced to other sources of data using CSV, Databases or RSS." />
|
|
</head>
|
|
<body data-toc="widgets">
|
|
<!-- Copyright 2020 Xibo Signage Ltd. Part of the Xibo Open Source Digital Signage Solution. Released under the AGPLv3 or later. -->
|
|
<nav id="top-nav" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#ss-navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<a href="#" class="navbar-brand">OTS Signs Command Center Documentation</a>
|
|
</div>
|
|
|
|
<div class="collapse navbar-collapse" id="ss-navbar">
|
|
<ul class="nav navbar-nav">
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="ss_body container">
|
|
<div class="row">
|
|
<div class="col-md-3">
|
|
<ul id="side-nav" class="nav nav-pills nav-stacked">
|
|
<li><a href="index.html" data-toc-name="getting_started">Getting Started</a></li><li><a href="layouts_editor.html" data-toc-name="layouts">Layouts</a></li><li><a href="media_library.html" data-toc-name="media">Media</a></li><li><a href="media_modules.html" data-toc-name="widgets">Modules</a></li><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
<html><body><ul>
|
|
<li class="active">
|
|
<a href="media_modules.html">Modules</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_modules_connectors.html">Connectors</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_audio.html">Audio</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_calendar.html">Calendar</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_clock.html">Clock</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_countdown.html">Countdown</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_currencies.html">Currencies</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_dashboard.html">Dashboard</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_dataset.html">DataSet</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_embedded.html">Embedded</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_emergency_alerts.html">Emergency Alert</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_flash.html">Flash</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_googletraffic.html">Google Traffic</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_hls.html">HLS</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_htmlpackage.html">HTML Package</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_image.html">Image</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_localvideo.html">Local Video</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_mastodon.html">Mastodon</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_menuboards_category.html">Menu Board Category</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_menuboards_products.html">Menu Board Products</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_national_weather_service.html">National Weather Service</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_notifications.html">Notifications</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_pdf.html">PDF</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_powerpoint.html">PowerPoint</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_shellcommand.html">Shell Command</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_stocks.html">Stocks</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_ticker.html">Ticker</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_video.html">Video</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_video_in.html">Video In</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_weather.html">Weather</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_webpage.html">Webpage</a>
|
|
</li>
|
|
<li>
|
|
<a href="media_module_world_clock.html">World Clock</a>
|
|
</li>
|
|
</ul>
|
|
</body></html>
|
|
<li><a href="scheduling_events.html" data-toc-name="scheduling">Scheduling</a></li><li><a href="displays.html" data-toc-name="displays">Displays</a></li><li><a href="users_administration.html" data-toc-name="users">Users</a></li><li><a href="configure_cms_settings.html" data-toc-name="configure">Configuration and Organisation</a></li><li><a href="troubleshooting.html" data-toc-name="troubleshooting">Troubleshooting</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="col-md-9" role="main">
|
|
<h1 id="modules_management">Modules Management <a href="#modules_management" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
|
<p>All content displayed in OTS Signs Command Center is served by a <strong>Media Module</strong> managed from the <strong>Modules</strong> page under the <strong>Administration</strong> section of the main CMS menu:</p>
|
|
<p><img src="img/v4_media_modules_grid.png" alt="Modules Grid" /></p>
|
|
<ul>
|
|
<li>Use the row menu and click <strong>Configure</strong> to control if it should be accessible for Users to use.</li>
|
|
</ul>
|
|
<blockquote class="tip"><p>At times it may be necessary to add or remove the allowed extensions on a particular Library file based Module (Image, Video, Flash etc.) A typical use case would be if a Player is being used which does not support that particular type of file.</p>
|
|
<p>Fonts can be added and managed from the <strong>Fonts</strong> page under the <strong>Administration</strong> section of the main CMS menu. See <a href="configure_cms_settings.html">CMS Settings</a> for more information.</p>
|
|
</blockquote>
|
|
<h2 id="caching_and_external_access">Caching and external access <a href="#caching_and_external_access" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
|
<p>The core Modules are designed to have their data cached and served from the CMS so that they can be played back without an active connection and/or without direct access to external resources that might be required. The CMS also uses this mechanism to be a <em>good citizen</em> when requesting 3rd party data.</p>
|
|
<blockquote class="tip"><p>For example, a Ticker Widget with the address <code>http://anexternal.com/feed</code> would only be accessed by the CMS and only once per <code>updateInterval</code>. The Players showing the Layout would not need to access that address directly.</p>
|
|
</blockquote>
|
|
<p>All of the core Modules adopt this approach, exceptions noted below:</p>
|
|
<ul>
|
|
<li>The <strong>Web Page Module</strong> does not cache from the CMS and will always attempt to open the specified web page address using the browser on the Player. This means that the Player must have network access to the web address at all times.</li>
|
|
<li>The <strong>Embedded Module</strong> can be cached using library references, however, the User that creates the Module is free to specify external resources should they require them.</li>
|
|
<li>The <strong>Local Video Module</strong> is rendered by the video decoder on the Player and can reference an external stream.</li>
|
|
<li>
|
|
<strong>Flash</strong> Files have the capability to reference an external file and will be run on the Player.</li>
|
|
</ul>
|
|
<h2 id="generic_file">Generic File <a href="#generic_file" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
|
<p>The Generic File Module is used to send <strong>additional files</strong> to the Player that can then be used for other purposes.</p>
|
|
<blockquote class="tip"><p>This could be useful for providing supplementary files to be used as relative paths (e.g. An up and down arrow that is dynamically shown in the embedded HTML based on the results of stock data) as an example.</p>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
</div> <!-- container-->
|
|
<footer class="ss_footer" role="contentinfo">
|
|
<div class="container">
|
|
<div class="pull-right">
|
|
<img class="img-responsive logo" src="../img/logo.png" alt="OTS Signs Command Center" />
|
|
</div>
|
|
|
|
<p class="ss_back_to_top">Back to Top</p>
|
|
|
|
<p class="ss_footer_links">Currently v4</p>
|
|
|
|
<p class="ss_languages"><a href="../en/index.html">en</a></p>
|
|
</div>
|
|
</footer>
|
|
|
|
<!-- JavaScript -->
|
|
<script src="../vendor/jquery/jquery.min.js"></script>
|
|
<script src="../vendor/bootstrap/js/bootstrap.min.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() {
|
|
$(".ss-sidebar .list-group li").addClass("list-group-item");
|
|
$(".ss_body img").addClass("img-thumbnail");
|
|
$(".ss_body table").addClass("table");
|
|
|
|
// Set the selected page based on the TOC name
|
|
// Mark the appropriate top nav element as the selected page
|
|
$("#top-nav a").each(function() {
|
|
if ($(this).data().tocName == $("body").data().toc)
|
|
$(this).parent().addClass("active");
|
|
});
|
|
|
|
$(".ss_back_to_top").click(function() {
|
|
$('html, body').animate({scrollTop : 0},800);
|
|
});
|
|
|
|
if (inIframe()) {
|
|
console.log("In Frame");
|
|
$("#top-nav").css("display", "none");
|
|
$(".ss-sidebar").parent().css("display", "none");
|
|
}
|
|
});
|
|
|
|
function inIframe () {
|
|
try {
|
|
return window.self !== window.top;
|
|
} catch (e) {
|
|
return true;
|
|
}
|
|
}
|
|
</script>
|
|
</body>
|
|
</html>
|