Compare commits
20 Commits
287e03da42
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9a9ec7661c | ||
|
|
8f9179998f | ||
|
|
a917d056fc | ||
|
|
894633e8d0 | ||
|
|
bbe8c1860c | ||
|
|
87474b05a9 | ||
|
|
e44a77b284 | ||
|
|
0e4cb80297 | ||
| 42116cb0a7 | |||
|
|
b766487411 | ||
|
|
29b56bef4f | ||
|
|
54e092ec01 | ||
|
|
86030cb881 | ||
|
|
1c5c23f100 | ||
|
|
edd112fec3 | ||
|
|
87a444b8de | ||
|
|
122d098be4 | ||
|
|
d8f8c0f916 | ||
|
|
f392e5d016 | ||
|
|
2153d3c725 |
87
.github/copilot-instructions.md
vendored
Normal file
@@ -0,0 +1,87 @@
|
||||
# OTS Signs Theme — Copilot Instructions
|
||||
|
||||
Custom Xibo CMS theme for OTS Signs digital signage service. Built with Twig templates, vanilla CSS, and vanilla JS. No build pipeline — all assets are inlined at runtime.
|
||||
|
||||
## Architecture
|
||||
|
||||
- **Template engine**: Twig, inheriting from Xibo core's `base.twig`
|
||||
- **Entry point**: `ots-signs/views/authed.twig` — wraps all authenticated pages (sidebar + topbar + content)
|
||||
- **CSS delivery**: CSS files are **inlined** inside `<style nonce="...">` tags via `theme-javascript.twig`, not served as static files. This is intentional — it avoids MIME routing issues under the `custom/` path and ensures CSP nonce compliance.
|
||||
- **JS delivery**: Same inline strategy via `theme-scripts.twig`
|
||||
- **Config**: `ots-signs/config.php` — sets theme name, URLs, feature flags
|
||||
|
||||
### Twig inheritance
|
||||
```
|
||||
base.twig (Xibo core)
|
||||
├── authed.twig ← most pages extend this
|
||||
│ ├── dashboard-icon-page.twig
|
||||
│ ├── layout-page.twig
|
||||
│ └── [40+ admin page templates]
|
||||
└── login.twig
|
||||
```
|
||||
|
||||
Partials included in `authed.twig`: `authed-sidebar.twig`, `authed-topbar.twig`, `authed-user-menu.twig`, `authed-notification-drawer.twig`
|
||||
|
||||
## Key Xibo Template APIs
|
||||
|
||||
These are available in all authenticated Twig templates:
|
||||
|
||||
```twig
|
||||
{# Permission-gated rendering #}
|
||||
{% if currentUser.featureEnabled("layout.view") %}...{% endif %}
|
||||
|
||||
{# User preferences #}
|
||||
{% set navPos = currentUser.getOptionValue("navigationMenuPosition", "vertical") %}
|
||||
|
||||
{# Theme helpers #}
|
||||
{{ theme.uri("css/override.css") }}
|
||||
{{ theme.getSetting("DEFAULT_VALUE", fallback) }}
|
||||
{{ url_for("routeName") }}
|
||||
{{ trans("string") }}
|
||||
```
|
||||
|
||||
## CSS Architecture
|
||||
|
||||
Primary file: `ots-signs/css/override.css`
|
||||
|
||||
- Primary color: `#e87800` (orange), exposed as `--primary-color`
|
||||
- Dark background: `#0f172a`, surface: `#1e293b`
|
||||
- Sidebar: 256px expanded / 64px collapsed (icon-only), controlled via CSS vars
|
||||
- `override-dark.css` handles component-level dark mode, floating menus, DataTable contrast
|
||||
|
||||
Do **not** add a build step (Sass, PostCSS, etc.) without first discussing it — the inline delivery mechanism requires plain CSS.
|
||||
|
||||
## JS Conventions
|
||||
|
||||
Single file: `ots-signs/js/theme.js` (440+ lines)
|
||||
|
||||
- IIFE pattern — no module bundler
|
||||
- Uses `localStorage` for theme (`ots-theme`) and sidebar state (`ots-sidebar-collapsed`)
|
||||
- MutationObserver watches for Xibo's layout editor modal, sets `body.ots-playlist-editor-active`
|
||||
- Mobile breakpoint: `768px`
|
||||
|
||||
## Deployment
|
||||
|
||||
Theme lives at: `web/theme/custom/otssigns-beta/` inside the Xibo CMS installation.
|
||||
The `view_path` in `config.php` must point to the absolute path of the `views/` directory.
|
||||
|
||||
## Common UI Patterns
|
||||
|
||||
| Pattern | Key class/element |
|
||||
|---------|------------------|
|
||||
| Icon dashboard cards | `.icon-dash-card` with `--blue`, `--green`, `--purple`, `--teal` color vars |
|
||||
| Data grids | `.XiboGrid` wrapper → DataTables (managed by Xibo core) |
|
||||
| Filter panels | `.XiboFilter` with tab-based advanced filter |
|
||||
| Page header | `.page-header` with `<h1>` + subtitle |
|
||||
| Toast/alerts | Bootstrap `.alert-danger/warning/success/info` |
|
||||
| Forms | `inline.*()` macro system from Xibo core |
|
||||
|
||||
## What This Repo Does NOT Have
|
||||
|
||||
- No `package.json`, no npm/yarn/pnpm
|
||||
- No webpack, Vite, Gulp, or Parcel
|
||||
- No TypeScript — plain JS only
|
||||
- No PHP unit tests in this repo (Xibo core testing is separate)
|
||||
- No CI/CD config
|
||||
|
||||
Don't suggest adding any of the above unless the user explicitly asks.
|
||||
18
COPYRIGHT
Normal file
@@ -0,0 +1,18 @@
|
||||
OTS Signs Theme
|
||||
Copyright (C) 2026 Oribi Technology Services
|
||||
|
||||
This theme is derived from Xibo Digital Signage CMS.
|
||||
Copyright (C) 2006-2026 Xibo Signage Ltd and Contributors.
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
361
CUSTOMIZATION.md
@@ -1,361 +0,0 @@
|
||||
# Theme Customization Cookbook
|
||||
|
||||
Quick recipes for common customization tasks in your Xibo CMS theme.
|
||||
|
||||
## 1. Change Primary Brand Color
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Find the `:root` selector and update:
|
||||
|
||||
```css
|
||||
:root {
|
||||
--color-primary: #006bb3; /* Change from blue #2563eb to custom blue */
|
||||
--color-primary-dark: #004c80; /* Darker shade for hover/active states */
|
||||
--color-primary-light: #1a9ad1; /* Lighter shade for backgrounds */
|
||||
--color-primary-lighter: #d4e6f1; /* Very light for highlights */
|
||||
}
|
||||
```
|
||||
|
||||
This single change affects:
|
||||
- Header bar background
|
||||
- Sidebar primary colors
|
||||
- Buttons, links, and focus states
|
||||
- Widget title bars
|
||||
|
||||
## 2. Use a Custom Font
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Replace the `--font-family-base` variable:
|
||||
|
||||
```css
|
||||
:root {
|
||||
/* Option A: Google Font (add to <head> in Twig override) */
|
||||
--font-family-base: "Inter", "Segoe UI", sans-serif;
|
||||
|
||||
/* Option B: Local font file */
|
||||
@font-face {
|
||||
font-family: "MyCustomFont";
|
||||
src: url('../fonts/my-font.woff2') format('woff2');
|
||||
}
|
||||
--font-family-base: "MyCustomFont", sans-serif;
|
||||
}
|
||||
```
|
||||
|
||||
To use Google Fonts, add this line to a Twig template (e.g., in a view override):
|
||||
```html
|
||||
<link rel="preconnect" href="https://fonts.googleapis.com">
|
||||
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet">
|
||||
```
|
||||
|
||||
## 3. Implement a Company Logo in Header
|
||||
|
||||
**Files:** `css/override.css` (styling), `img/` (asset)
|
||||
|
||||
1. Replace logo files in `custom/otssignange/img/`:
|
||||
- `xibologo.png` (header logo, ~40x40px)
|
||||
- `192x192.png` (app icon for app manifest)
|
||||
- `512x512.png` (splash/bookmarklet icon)
|
||||
|
||||
2. If you need to style the logo more prominently, add to `override.css`:
|
||||
|
||||
```css
|
||||
.navbar-brand {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: var(--space-2);
|
||||
padding-left: var(--space-4);
|
||||
}
|
||||
|
||||
.navbar-brand img {
|
||||
height: 40px;
|
||||
width: auto;
|
||||
}
|
||||
```
|
||||
|
||||
## 4. Darken the Sidebar
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Update sidebar color tokens:
|
||||
|
||||
```css
|
||||
:root {
|
||||
--color-surface: #2d3748; /* Darker gray instead of light */
|
||||
--color-text-primary: #ffffff; /* White text on dark background */
|
||||
}
|
||||
|
||||
#sidebar-wrapper {
|
||||
background-color: #1a202c; /* Even darker for contrast */
|
||||
}
|
||||
|
||||
ul.sidebar .sidebar-list a {
|
||||
color: #cbd5e1; /* Light gray text */
|
||||
}
|
||||
|
||||
ul.sidebar .sidebar-list a:hover {
|
||||
background-color: #2d3748; /* Slightly lighter on hover */
|
||||
color: #ffffff;
|
||||
}
|
||||
```
|
||||
|
||||
## 5. Increase Widget Spacing & Padding
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Modify spacing tokens to make everything roomier:
|
||||
|
||||
```css
|
||||
:root {
|
||||
/* Scale up all spacing */
|
||||
--space-4: 1.25rem; /* was 1rem (16px → 20px) */
|
||||
--space-6: 2rem; /* was 1.5rem (24px → 32px) */
|
||||
--space-8: 2.75rem; /* was 2rem (32px → 44px) */
|
||||
}
|
||||
|
||||
.widget {
|
||||
padding: var(--space-8); /* Uses new token value */
|
||||
}
|
||||
```
|
||||
|
||||
## 6. Remove Shadows (Flat Design)
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Set all shadows to none:
|
||||
|
||||
```css
|
||||
:root {
|
||||
--shadow-xs: none;
|
||||
--shadow-sm: none;
|
||||
--shadow-base: none;
|
||||
--shadow-md: none;
|
||||
--shadow-lg: none;
|
||||
--shadow-xl: none;
|
||||
}
|
||||
```
|
||||
|
||||
## 7. Customize Button Styles
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Make buttons larger with more rounded corners:
|
||||
|
||||
```css
|
||||
button,
|
||||
.btn {
|
||||
padding: var(--space-4) var(--space-6); /* Increase from var(--space-3) var(--space-4) */
|
||||
border-radius: var(--radius-xl); /* Make more rounded */
|
||||
font-weight: var(--font-weight-semibold); /* Make text bolder */
|
||||
text-transform: uppercase; /* OPTIONAL: Uppercase labels */
|
||||
letter-spacing: 0.05em; /* OPTIONAL: Wider letter spacing */
|
||||
}
|
||||
```
|
||||
|
||||
## 8. Force Light Mode (Disable Dark Mode)
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Remove the dark mode media query or override it:
|
||||
|
||||
```css
|
||||
/* Delete or comment out this section: */
|
||||
/*
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root { ... }
|
||||
}
|
||||
*/
|
||||
|
||||
/* OR force light mode explicitly: */
|
||||
:root {
|
||||
color-scheme: light; /* Tells browser to not apply dark UI elements */
|
||||
}
|
||||
|
||||
/* Force light colors even if system prefers dark */
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
/* Keep all light mode values, don't override */
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 9. Add a Custom Alert Style
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Append a new alert variant (e.g., for secondary notifications):
|
||||
|
||||
```css
|
||||
.alert-secondary {
|
||||
background-color: #e2e8f0;
|
||||
border-color: #cbd5e1;
|
||||
color: #334155;
|
||||
}
|
||||
|
||||
.alert-secondary a {
|
||||
color: #2563eb;
|
||||
font-weight: var(--font-weight-semibold);
|
||||
}
|
||||
```
|
||||
|
||||
Use in Xibo: Apply `.alert alert-secondary` class to a notification element.
|
||||
|
||||
## 10. Improve Form Focus States
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Make focused form inputs more prominent:
|
||||
|
||||
```css
|
||||
input[type="text"]:focus,
|
||||
input[type="email"]:focus,
|
||||
input[type="password"]:focus,
|
||||
textarea:focus,
|
||||
select:focus {
|
||||
outline: none;
|
||||
border-color: var(--color-primary);
|
||||
box-shadow: 0 0 0 4px var(--color-primary-lighter), /* Outer glow */
|
||||
0 0 0 1px var(--color-primary); /* Inner border */
|
||||
background-color: #fafbff; /* Subtle highlight */
|
||||
}
|
||||
```
|
||||
|
||||
## 11. Create a Compact Theme Variant
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Add a utility class for a denser layout:
|
||||
|
||||
```css
|
||||
.theme-compact {
|
||||
--space-4: 0.75rem;
|
||||
--space-6: 1rem;
|
||||
--font-size-base: 0.875rem; /* Slightly smaller text */
|
||||
}
|
||||
|
||||
/* Apply to body or any container */
|
||||
body.theme-compact {
|
||||
/* All tokens inherit new values */
|
||||
}
|
||||
```
|
||||
|
||||
Then toggle with a Twig override or JS:
|
||||
```javascript
|
||||
document.body.classList.toggle('theme-compact');
|
||||
```
|
||||
|
||||
## 12. Modify Widget Title Bar Colors
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Make widget titles more distinctive:
|
||||
|
||||
```css
|
||||
.widget .widget-title {
|
||||
background: linear-gradient(135deg, var(--color-primary), var(--color-primary-dark));
|
||||
color: var(--color-text-inverse);
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.05em;
|
||||
font-size: var(--font-size-sm);
|
||||
padding: var(--space-6);
|
||||
border-bottom: 2px solid var(--color-primary-dark);
|
||||
}
|
||||
```
|
||||
|
||||
## 13. Style Table Headers Distinctly
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Make tables look more modern:
|
||||
|
||||
```css
|
||||
thead {
|
||||
background: linear-gradient(to bottom, var(--color-primary-lighter), var(--color-gray-100));
|
||||
}
|
||||
|
||||
th {
|
||||
color: var(--color-primary);
|
||||
font-weight: var(--font-weight-bold);
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.05em;
|
||||
font-size: var(--font-size-sm);
|
||||
padding: var(--space-6) var(--space-4);
|
||||
border-bottom: 2px solid var(--color-primary);
|
||||
}
|
||||
|
||||
tbody tr:nth-child(odd) {
|
||||
background-color: var(--color-gray-50);
|
||||
}
|
||||
|
||||
tbody tr:hover {
|
||||
background-color: var(--color-primary-lighter);
|
||||
}
|
||||
```
|
||||
|
||||
## 14. Enable Full Dark Mode in Browser
|
||||
|
||||
Some users may have `prefers-color-scheme: dark` set. To test locally:
|
||||
|
||||
**Chrome DevTools:**
|
||||
1. Open DevTools (F12)
|
||||
2. Ctrl+Shift+P (or Cmd+Shift+P on Mac)
|
||||
3. Type "rendering"
|
||||
4. Select "Show Rendering"
|
||||
5. Scroll to "Prefers color scheme" and select "dark"
|
||||
6. Refresh page
|
||||
|
||||
**Firefox:**
|
||||
1. about:config
|
||||
2. Search for `ui.systemUsesDarkTheme`
|
||||
3. Set to `1` for dark mode
|
||||
|
||||
## 15. Add Custom Utility Classes
|
||||
|
||||
**File:** `css/override.css`
|
||||
|
||||
Extend the theme with custom utilities at the end:
|
||||
|
||||
```css
|
||||
/* Custom utilities */
|
||||
.text-primary {
|
||||
color: var(--color-primary);
|
||||
}
|
||||
|
||||
.bg-primary {
|
||||
background-color: var(--color-primary);
|
||||
color: var(--color-text-inverse);
|
||||
}
|
||||
|
||||
.border-primary {
|
||||
border-color: var(--color-primary);
|
||||
}
|
||||
|
||||
.opacity-50 {
|
||||
opacity: 0.5;
|
||||
}
|
||||
|
||||
.cursor-pointer {
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.no-wrap {
|
||||
white-space: nowrap;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
}
|
||||
|
||||
.flex-center {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Pro Tips:**
|
||||
- Always test changes in a staging Xibo instance before deploying to production
|
||||
- Use browser DevTools to inspect elements and live-edit CSS before making permanent changes
|
||||
- Keep a backup of your original CSS before making large modifications
|
||||
- Document any custom changes you make in comments within the CSS file for future reference
|
||||
175
DEPLOYMENT.md
@@ -1,175 +0,0 @@
|
||||
# Deployment Checklist & Quick Start
|
||||
|
||||
## Pre-Deployment Checklist
|
||||
|
||||
- [ ] Review the modern theme changes in [README.md](README.md)
|
||||
- [ ] Test CSS syntax validation (no errors reported)
|
||||
- [ ] Backup existing `custom/otssignange/css/override.css`
|
||||
- [ ] Verify asset paths (logos, preview images)
|
||||
- [ ] Check browser compatibility requirements
|
||||
- [ ] Test on your development Xibo instance first
|
||||
- [ ] Verify dark mode toggle if using system preference
|
||||
- [ ] Test responsive layout on mobile devices
|
||||
|
||||
## Installation Steps
|
||||
|
||||
### Option A: Direct File Copy
|
||||
|
||||
```bash
|
||||
# Navigate to your Xibo installation root
|
||||
cd /path/to/xibo
|
||||
|
||||
# Backup original theme files
|
||||
cp web/theme/custom/otssignange/css/override.css web/theme/custom/otssignange/css/override.css.backup
|
||||
cp web/theme/custom/otssignange/css/html-preview.css web/theme/custom/otssignange/css/html-preview.css.backup
|
||||
|
||||
# Copy new theme files
|
||||
cp /Users/matt/dev/theme/custom/otssignange/css/override.css web/theme/custom/otssignange/css/
|
||||
cp /Users/matt/dev/theme/custom/otssignange/css/html-preview.css web/theme/custom/otssignange/css/
|
||||
cp /Users/matt/dev/theme/custom/otssignange/css/client.css web/theme/custom/otssignange/css/
|
||||
|
||||
# Verify files copied
|
||||
ls -la web/theme/custom/otssignange/css/
|
||||
```
|
||||
|
||||
### Option B: Using Git (if version-controlled)
|
||||
|
||||
```bash
|
||||
cd /path/to/xibo
|
||||
git checkout web/theme/custom/otssignange/css/
|
||||
# Or manually merge your changes with the new files
|
||||
```
|
||||
|
||||
## Post-Deployment Validation
|
||||
|
||||
1. **Clear Xibo Cache** (if applicable):
|
||||
```bash
|
||||
# Xibo may cache CSS—clear if using PHP APC or similar
|
||||
rm -rf web/uploads/temp/*
|
||||
```
|
||||
|
||||
2. **Verify in Browser**:
|
||||
- Open Xibo CMS admin interface
|
||||
- Inspect elements for CSS color changes
|
||||
- Check Network tab for CSS file loads (should see override.css)
|
||||
- Verify no CSS errors in browser console
|
||||
|
||||
3. **Test Key Features**:
|
||||
- [ ] Login page displays correctly
|
||||
- [ ] Header bar shows primary color
|
||||
- [ ] Sidebar navigation is styled properly
|
||||
- [ ] Dashboard widgets render as cards with shadows
|
||||
- [ ] Links have correct color and hover state
|
||||
- [ ] Forms have proper focus states (blue outline)
|
||||
- [ ] Mobile layout: open DevTools (F12) and resize to <640px
|
||||
- [ ] Sidebar collapses into hamburger menu on mobile
|
||||
- [ ] Dark mode: open DevTools → Rendering → Prefers color scheme: dark
|
||||
|
||||
4. **Check Asset Loading**:
|
||||
- Verify `xibologo.png` displays in header
|
||||
- Check preview splash screen background loads
|
||||
- Confirm favicon appears in browser tab
|
||||
|
||||
## Rollback Plan
|
||||
|
||||
If issues occur:
|
||||
|
||||
```bash
|
||||
cd /path/to/xibo
|
||||
|
||||
# Restore backup
|
||||
cp web/theme/custom/otssignange/css/override.css.backup web/theme/custom/otssignange/css/override.css
|
||||
cp web/theme/custom/otssignange/css/html-preview.css.backup web/theme/custom/otssignange/css/html-preview.css
|
||||
|
||||
# Optional: Remove new client.css if causing issues
|
||||
rm web/theme/custom/otssignange/css/client.css
|
||||
|
||||
# Clear cache
|
||||
rm -rf web/uploads/temp/*
|
||||
|
||||
# Refresh browser (Ctrl+Shift+R for hard refresh)
|
||||
```
|
||||
|
||||
## Browser Support
|
||||
|
||||
### Fully Supported (CSS Variables)
|
||||
- Chrome/Edge 49+
|
||||
- Firefox 31+
|
||||
- Safari 9.1+
|
||||
- Opera 36+
|
||||
- Mobile browsers (iOS Safari 9.3+, Chrome Mobile 49+)
|
||||
|
||||
### Partial Support (Fallbacks Recommended)
|
||||
- IE 11 and below: Not supported
|
||||
|
||||
To add IE11 fallbacks, modify `override.css` (advanced):
|
||||
```css
|
||||
/* Fallback for older browsers */
|
||||
.widget {
|
||||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.12), 0 1px 2px rgba(0, 0, 0, 0.24); /* IE fallback */
|
||||
box-shadow: var(--shadow-sm);
|
||||
}
|
||||
```
|
||||
|
||||
## Performance Notes
|
||||
|
||||
- **CSS File Size**: `override.css` is ~35KB (gzipped ~8KB)
|
||||
- **Variables**: 70+ CSS variables—negligible performance impact
|
||||
- **Dark Mode**: Uses `prefers-color-scheme` media query (no JavaScript required)
|
||||
- **Responsive**: Mobile-first approach—efficient layout recalculation
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Optional Enhancements**:
|
||||
- Add SVG icon sprite to `img/` for consistent iconography
|
||||
- Create Twig view overrides for deeper layout customization
|
||||
- Implement user-controlled dark mode toggle
|
||||
|
||||
2. **Documentation**:
|
||||
- See [CUSTOMIZATION.md](CUSTOMIZATION.md) for 15+ customization recipes
|
||||
- See [README.md](README.md) for full feature documentation
|
||||
|
||||
3. **Testing in CI/CD**:
|
||||
- Add CSS linter (stylelint) to your build pipeline
|
||||
- Validate HTML/CSS in staging before production push
|
||||
|
||||
## Support & Troubleshooting
|
||||
|
||||
### Issue: CSS Not Loading
|
||||
**Solution**:
|
||||
- Hard refresh browser: Ctrl+Shift+R (Windows/Linux) or Cmd+Shift+R (Mac)
|
||||
- Check browser console for 404 errors on CSS files
|
||||
- Verify file permissions: `chmod 644 override.css`
|
||||
|
||||
### Issue: Colors Look Wrong
|
||||
**Solution**:
|
||||
- Check if system dark mode is enabled (see Post-Deployment Validation)
|
||||
- Verify `--color-primary` value in `:root` matches intended brand color
|
||||
- Test in different browsers
|
||||
|
||||
### Issue: Sidebar Doesn't Collapse on Mobile
|
||||
**Solution**:
|
||||
- Verify viewport meta tag is in Xibo's `<head>`: `<meta name="viewport" content="width=device-width, initial-scale=1">`
|
||||
- Check browser DevTools for responsive mode enabled
|
||||
- Ensure no custom CSS is overriding the media query
|
||||
|
||||
### Issue: Fonts Not Loading
|
||||
**Solution**:
|
||||
- Verify system fonts are available (`-apple-system`, `Segoe UI`, etc.)
|
||||
- If using Google Fonts, check internet connectivity
|
||||
- Add font-family fallback: `-fallback-font, sans-serif`
|
||||
|
||||
---
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Theme README](README.md) — Feature overview and tokens reference
|
||||
- [Customization Cookbook](CUSTOMIZATION.md) — 15+ customization recipes
|
||||
- [Xibo Developer Docs](https://account.xibosignage.com/docs/developer/)
|
||||
- [Config Reference](custom/otssignange/config.php)
|
||||
|
||||
---
|
||||
|
||||
**Version**: 1.0.0 (Modern)
|
||||
**Last Updated**: February 2026
|
||||
**Status**: Ready for Production
|
||||
391
DESIGN_SYSTEM.md
@@ -1,391 +0,0 @@
|
||||
# Design System Reference Card
|
||||
|
||||
A quick visual and technical reference for the OTS Signage Modern Theme.
|
||||
|
||||
## 🎨 Color Palette
|
||||
|
||||
### Brand Colors
|
||||
```
|
||||
--color-primary #2563eb ████████████ Blue
|
||||
--color-primary-dark #1d4ed8 ██████████ Darker Blue
|
||||
--color-primary-light #3b82f6 ██████████████ Lighter Blue
|
||||
--color-secondary #7c3aed ████████████ Purple
|
||||
```
|
||||
|
||||
### Status Colors
|
||||
```
|
||||
--color-success #10b981 ██████████ Green
|
||||
--color-warning #f59e0b ██████████ Amber
|
||||
--color-danger #ef4444 ██████████ Red
|
||||
--color-info #0ea5e9 ██████████ Cyan
|
||||
```
|
||||
|
||||
### Gray Scale (Neutral)
|
||||
```
|
||||
Level Color Hex Usage
|
||||
50 Very Light #f9fafb Backgrounds, light surfaces
|
||||
100 Light #f3f4f6 Hover states, borders
|
||||
200 Light Gray #e5e7eb Borders, dividers
|
||||
300 Gray #d1d5db Form inputs, disabled
|
||||
400 Gray #9ca3af Placeholder text
|
||||
500 Medium Gray #6b7280 Secondary text
|
||||
600 Dark Gray #4b5563 Body text, labels
|
||||
700 Darker Gray #374151 Headings
|
||||
800 Very Dark #1f2937 Primary text
|
||||
900 Darkest #111827 High contrast text
|
||||
```
|
||||
|
||||
### Semantic Colors
|
||||
```
|
||||
--color-background #ffffff (dark: #0f172a)
|
||||
--color-surface #f9fafb (dark: #1e293b)
|
||||
--color-surface-elevated #ffffff (dark: #334155)
|
||||
--color-text-primary #1f2937 (dark: #f1f5f9)
|
||||
--color-text-secondary #6b7280 (dark: #cbd5e1)
|
||||
--color-text-tertiary #9ca3af (dark: #94a3b8)
|
||||
--color-border #e5e7eb (dark: #475569)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📝 Typography Scale
|
||||
|
||||
### Font Family
|
||||
```
|
||||
--font-family-base: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif
|
||||
--font-family-mono: "SF Mono", Monaco, "Cascadia Code", "Roboto Mono", Menlo, Courier, monospace
|
||||
```
|
||||
|
||||
### Font Sizes
|
||||
```
|
||||
Size Pixels Usage
|
||||
--font-size-xs 12px Small labels, badges, captions
|
||||
--font-size-sm 14px Form hints, table cells, small text
|
||||
--font-size-base 16px Body text, default size
|
||||
--font-size-lg 18px Subheadings, callouts
|
||||
--font-size-xl 20px Section headings
|
||||
--font-size-2xl 24px Page headings
|
||||
--font-size-3xl 30px Large headings
|
||||
--font-size-4xl 36px Main titles
|
||||
```
|
||||
|
||||
### Font Weights
|
||||
```
|
||||
Weight Value Usage
|
||||
--font-weight-normal 400 Body text, regular content
|
||||
--font-weight-medium 500 Form labels, emphasis
|
||||
--font-weight-semibold 600 Headings, strong emphasis
|
||||
--font-weight-bold 700 Major headings, highlights
|
||||
```
|
||||
|
||||
### Line Heights
|
||||
```
|
||||
Height Value Usage
|
||||
--line-height-tight 1.25 Tight headings
|
||||
--line-height-snug 1.375 Subheadings
|
||||
--line-height-normal 1.5 Default, body text
|
||||
--line-height-relaxed 1.625 Large text blocks
|
||||
--line-height-loose 2 Extra spacing
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📏 Spacing Scale (8px base unit)
|
||||
|
||||
```
|
||||
Token Pixels CSS Rem
|
||||
--space-1 4px 0.25rem Tightest spacing
|
||||
--space-2 8px 0.5rem Small padding
|
||||
--space-3 12px 0.75rem Medium-small
|
||||
--space-4 16px 1rem Standard padding
|
||||
--space-5 20px 1.25rem Medium spacing
|
||||
--space-6 24px 1.5rem Default margins
|
||||
--space-7 28px 1.75rem Large spacing
|
||||
--space-8 32px 2rem Section spacing
|
||||
--space-10 40px 2.5rem Large spacing
|
||||
--space-12 48px 3rem Very large
|
||||
--space-16 64px 4rem Extra large
|
||||
--space-20 80px 5rem Massive spacing
|
||||
```
|
||||
|
||||
**Usage Example:**
|
||||
```css
|
||||
.widget {
|
||||
padding: var(--space-6); /* 24px all sides */
|
||||
margin-bottom: var(--space-8); /* 32px below */
|
||||
gap: var(--space-4); /* 16px between items */
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎭 Shadows (Elevation System)
|
||||
|
||||
```
|
||||
Level Shadow Usage
|
||||
none none No elevation
|
||||
xs 0 1px 2px 0 rgba(0, 0, 0, 0.05) Subtle depth
|
||||
sm 0 1px 3px 0 rgba(0, 0, 0, 0.1), 0 1px 2px 0 ... Small cards
|
||||
base 0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px ... Default cards
|
||||
md 0 10px 15px -3px rgba(0, 0, 0, 0.1), 0 4px 6px -2px ... Medium elevation
|
||||
lg 0 20px 25px -5px rgba(0, 0, 0, 0.1), 0 10px 10px ... Large hover
|
||||
xl 0 25px 50px -12px rgba(0, 0, 0, 0.25) Maximum depth
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔲 Border Radius
|
||||
|
||||
```
|
||||
Token Pixels Usage
|
||||
--radius-none 0px Sharp corners
|
||||
--radius-sm 4px Minimal rounding
|
||||
--radius-base 6px Default input fields
|
||||
--radius-md 8px Standard components
|
||||
--radius-lg 12px Cards, modals
|
||||
--radius-xl 16px Large containers
|
||||
--radius-2xl 24px Extra rounded
|
||||
--radius-full 9999px Fully rounded (pills, circles)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Transitions
|
||||
|
||||
```
|
||||
Token Duration Easing Usage
|
||||
--transition-fast 150ms ease-in-out Hover, quick interactions
|
||||
--transition-base 200ms ease-in-out Default, UI changes
|
||||
--transition-slow 300ms ease-in-out Page transitions, major changes
|
||||
```
|
||||
|
||||
**Usage:**
|
||||
```css
|
||||
a {
|
||||
transition: color var(--transition-fast);
|
||||
}
|
||||
|
||||
.widget {
|
||||
transition: box-shadow var(--transition-base), transform var(--transition-base);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📱 Responsive Breakpoints
|
||||
|
||||
```
|
||||
Name Width Use Case
|
||||
sm 640px Mobile phones (landscape)
|
||||
md 768px Tablets
|
||||
lg 1024px Desktop screens
|
||||
xl 1280px Large desktops
|
||||
2xl 1536px Ultra-wide displays
|
||||
```
|
||||
|
||||
**Usage Pattern (Mobile-First):**
|
||||
```css
|
||||
/* Mobile first (default) */
|
||||
.widget {
|
||||
grid-template-columns: 1fr;
|
||||
}
|
||||
|
||||
/* Tablets and up */
|
||||
@media (min-width: 768px) {
|
||||
.widget {
|
||||
grid-template-columns: repeat(2, 1fr);
|
||||
}
|
||||
}
|
||||
|
||||
/* Desktops and up */
|
||||
@media (min-width: 1024px) {
|
||||
.widget {
|
||||
grid-template-columns: repeat(3, 1fr);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Component Reference
|
||||
|
||||
### Buttons
|
||||
```css
|
||||
.btn {
|
||||
padding: var(--space-3) var(--space-4); /* 12px × 16px */
|
||||
border-radius: var(--radius-md); /* 8px */
|
||||
font-weight: var(--font-weight-medium); /* 500 */
|
||||
font-size: var(--font-size-base); /* 16px */
|
||||
}
|
||||
|
||||
.btn-primary {
|
||||
background: var(--color-primary); /* #2563eb */
|
||||
color: var(--color-text-inverse); /* White */
|
||||
}
|
||||
|
||||
.btn-primary:hover {
|
||||
background: var(--color-primary-dark); /* #1d4ed8 */
|
||||
}
|
||||
```
|
||||
|
||||
### Form Inputs
|
||||
```css
|
||||
input, textarea, select {
|
||||
background: var(--color-background); /* #ffffff */
|
||||
border: 1px solid var(--color-border); /* #e5e7eb */
|
||||
border-radius: var(--radius-md); /* 8px */
|
||||
padding: var(--space-3) var(--space-4); /* 12px × 16px */
|
||||
font-size: var(--font-size-base); /* 16px */
|
||||
}
|
||||
|
||||
input:focus {
|
||||
border-color: var(--color-primary); /* #2563eb */
|
||||
box-shadow: 0 0 0 3px var(--color-primary-lighter);
|
||||
}
|
||||
```
|
||||
|
||||
### Cards/Widgets
|
||||
```css
|
||||
.widget {
|
||||
background: var(--color-surface-elevated); /* #ffffff */
|
||||
border: 1px solid var(--color-border); /* #e5e7eb */
|
||||
border-radius: var(--radius-lg); /* 12px */
|
||||
box-shadow: var(--shadow-sm); /* Subtle depth */
|
||||
padding: var(--space-6); /* 24px */
|
||||
}
|
||||
|
||||
.widget:hover {
|
||||
box-shadow: var(--shadow-base); /* More elevation */
|
||||
transform: translateY(-1px); /* Slight lift */
|
||||
}
|
||||
```
|
||||
|
||||
### Alerts
|
||||
```css
|
||||
.alert {
|
||||
border-radius: var(--radius-md); /* 8px */
|
||||
padding: var(--space-4) var(--space-6); /* 16px × 24px */
|
||||
border-left: 4px solid var(--color-success);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌙 Dark Mode
|
||||
|
||||
All colors automatically switch when `prefers-color-scheme: dark` is detected:
|
||||
|
||||
```css
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--color-background: #0f172a; /* Deep navy */
|
||||
--color-surface: #1e293b; /* Slate */
|
||||
--color-text-primary: #f1f5f9; /* Near white */
|
||||
/* ... other dark mode overrides ... */
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Test in Browser DevTools:**
|
||||
1. F12 (Open DevTools)
|
||||
2. Ctrl+Shift+P (Search in Chrome)
|
||||
3. Type "rendering"
|
||||
4. Toggle "Prefers color scheme" to dark
|
||||
5. Page updates instantly
|
||||
|
||||
---
|
||||
|
||||
## ♿ Accessibility
|
||||
|
||||
### Color Contrast
|
||||
```
|
||||
Element Ratio WCAG Level
|
||||
Primary text on white 7:1 AAA
|
||||
Secondary text on white 4.5:1 AA
|
||||
Links on white 5:1 AA
|
||||
Buttons 4.5:1 AA
|
||||
```
|
||||
|
||||
### Focus Indicators
|
||||
```css
|
||||
*:focus-visible {
|
||||
outline: 2px solid var(--color-primary); /* #2563eb */
|
||||
outline-offset: 2px;
|
||||
}
|
||||
```
|
||||
|
||||
### Keyboard Navigation
|
||||
- All interactive elements are tab-accessible
|
||||
- Logical tab order maintained
|
||||
- No keyboard traps
|
||||
- Focus always visible
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Using CSS Variables
|
||||
|
||||
### Override in Your Code
|
||||
```css
|
||||
/* In your custom CSS, you can override tokens: */
|
||||
:root {
|
||||
--color-primary: #006bb3; /* Your brand blue */
|
||||
--font-size-base: 18px; /* Larger default text */
|
||||
}
|
||||
|
||||
/* All components using tokens will update automatically */
|
||||
```
|
||||
|
||||
### Reference in Components
|
||||
```css
|
||||
.my-component {
|
||||
background: var(--color-surface);
|
||||
color: var(--color-text-primary);
|
||||
padding: var(--space-4);
|
||||
border-radius: var(--radius-md);
|
||||
box-shadow: var(--shadow-base);
|
||||
}
|
||||
```
|
||||
|
||||
### With Fallbacks (IE11 compat, optional)
|
||||
```css
|
||||
.my-component {
|
||||
background: #f9fafb; /* Fallback */
|
||||
background: var(--color-surface); /* Modern */
|
||||
|
||||
color: #1f2937; /* Fallback */
|
||||
color: var(--color-text-primary); /* Modern */
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 Quick Lookup Table
|
||||
|
||||
| Need | Variable | Value |
|
||||
|------|----------|-------|
|
||||
| Brand color | `--color-primary` | #2563eb |
|
||||
| Button padding | `--space-3` + `--space-4` | 12px × 16px |
|
||||
| Card shadow | `--shadow-base` | 4px 6px -1px rgba... |
|
||||
| Body text | `--font-size-base` | 16px |
|
||||
| Heading | `--font-size-2xl` | 24px |
|
||||
| Default spacing | `--space-6` | 24px |
|
||||
| Card radius | `--radius-lg` | 12px |
|
||||
| Focus outline | `--color-primary` | #2563eb |
|
||||
| Dark background | --color-surface (dark mode) | #1e293b |
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Pro Tips
|
||||
|
||||
1. **Always use variables** — Don't hardcode colors or sizes
|
||||
2. **Spacing is 8px-based** — Use `--space-*` for consistency
|
||||
3. **Test dark mode** — Use DevTools (see above)
|
||||
4. **Mobile-first queries** — Styles default to mobile, expand on larger screens
|
||||
5. **Focus states matter** — Never remove `outline` without adding alternative
|
||||
6. **Semantic colors** — Use `--color-surface` instead of hardcoding #ffffff
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: February 2026
|
||||
**Theme Version**: 1.0.0 (Modern)
|
||||
**Xibo Compatibility**: 3.x+
|
||||
@@ -1,307 +0,0 @@
|
||||
# Implementation Summary: OTS Signs Xibo Theme Redesign
|
||||
|
||||
## ✅ Complete Implementation
|
||||
|
||||
Your custom Xibo CMS theme has been fully redesigned and modernized to match the screenshots you provided. All major views and components have been replaced with a contemporary dark-themed UI.
|
||||
|
||||
---
|
||||
|
||||
## 📋 What Was Changed
|
||||
|
||||
### **View Files (5 files updated)**
|
||||
|
||||
| File | Changes |
|
||||
|------|---------|
|
||||
| `authed.twig` | Modern shell layout with fixed sidebar (250px) + main area. SVG icons in topbar, responsive hamburger menu, user avatar dropdown |
|
||||
| `authed-sidebar.twig` | Reorganized navigation with section dividers, SVG icons for all menu items, user profile card at bottom |
|
||||
| `dashboard.twig` | 3-column KPI card grid (Displays, Schedules, Users), status panels, quick action grid with 3 action cards |
|
||||
| `displays.twig` | Two-column layout: left folder tree with 6 folder items, right content with search bar, stat boxes, modern data table |
|
||||
| `media.twig` | Two-column layout: left folder tree, right media grid with 4 sample images, storage stats, media type badges |
|
||||
|
||||
### **CSS Styling (override.css - ~1,050 lines)**
|
||||
|
||||
**Dark theme colors:**
|
||||
- Background: `#0f172a` (dark navy)
|
||||
- Surface: `#1e293b` (slate)
|
||||
- Elevated: `#334155` (darker slate)
|
||||
- Primary: `#3b82f6` (bright blue)
|
||||
- Text: `#f1f5f9` (off-white)
|
||||
|
||||
**Component system:**
|
||||
- ✅ Sidebar (fixed, collapsible on mobile)
|
||||
- ✅ Topbar (search, notifications, user menu)
|
||||
- ✅ KPI cards (3-column grid, hover effects)
|
||||
- ✅ Badges (success, danger, info, secondary)
|
||||
- ✅ Panels (full-width and half-width)
|
||||
- ✅ Tables (striped, hover states)
|
||||
- ✅ Media grid (3-column, responsive)
|
||||
- ✅ Buttons (primary, outline, small, ghost)
|
||||
- ✅ Forms (search input styling)
|
||||
- ✅ Responsive layout (768px breakpoint)
|
||||
|
||||
### **JavaScript (theme.js - ~120 lines)**
|
||||
|
||||
- Sidebar toggle on mobile
|
||||
- Dropdown menu interactions
|
||||
- Search focus states
|
||||
- Folder item selection feedback
|
||||
- Mobile viewport detection
|
||||
- Click-outside-to-close menus
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Key Visual Changes
|
||||
|
||||
### **Before → After**
|
||||
|
||||
| Element | Before | After |
|
||||
|---------|--------|-------|
|
||||
| **Background** | Light white | Dark navy (#0f172a) |
|
||||
| **Sidebar** | Icon emoji (📊🖥📁) | SVG icons + proper hierarchy |
|
||||
| **Dashboard KPI** | Simple text cards | Large numbered cards with gradients |
|
||||
| **Tables** | Basic Bootstrap | Modern dark tables with hover states |
|
||||
| **Buttons** | Basic styling | Modern gradient primary, outline variants |
|
||||
| **Media Items** | Text list | Image thumbnail grid with badges |
|
||||
| **Navigation** | Flat list | Organized sections with dividers |
|
||||
|
||||
---
|
||||
|
||||
## 📁 Files Modified
|
||||
|
||||
```
|
||||
custom/otssignange/
|
||||
├── config.php ..................... (unchanged - already correct)
|
||||
├── css/
|
||||
│ ├── override.css ............... ✅ REPLACED (1,050 lines dark theme)
|
||||
│ ├── client.css ................. (unchanged)
|
||||
│ └── html-preview.css ........... (unchanged)
|
||||
├── js/
|
||||
│ └── theme.js ................... ✅ UPDATED (interactivity)
|
||||
└── views/
|
||||
├── authed.twig ................ ✅ REPLACED (shell + topbar)
|
||||
├── authed-sidebar.twig ........ ✅ REPLACED (nav sidebar)
|
||||
├── dashboard.twig ............. ✅ REPLACED (KPI cards)
|
||||
├── displays.twig .............. ✅ REPLACED (two-column)
|
||||
├── media.twig ................. ✅ REPLACED (media grid)
|
||||
├── index.html ................. (unchanged)
|
||||
└── layouts/ ................... (inherited from Xibo)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Next Steps
|
||||
|
||||
### 1. **Deploy to Xibo CMS**
|
||||
|
||||
If you have Xibo installed locally:
|
||||
|
||||
```bash
|
||||
# Copy theme to Xibo installation
|
||||
cp -r /path/to/otssignstheme/custom/otssignange /path/to/xibo-cms/web/theme/custom/
|
||||
|
||||
# Clear cache in Xibo admin UI:
|
||||
# Settings → Maintenance → Purge Cache
|
||||
```
|
||||
|
||||
### 2. **Enable Theme in Xibo**
|
||||
|
||||
1. Log in to Xibo CMS admin
|
||||
2. Go to **Settings → Preferences → Themes**
|
||||
3. Select **"OTS Signs"** from dropdown
|
||||
4. Click **Save**
|
||||
5. Refresh browser
|
||||
|
||||
### 3. **Test Pages**
|
||||
|
||||
After enabling, verify these pages render correctly:
|
||||
|
||||
- [ ] **Dashboard** - KPI cards should display (3 columns)
|
||||
- [ ] **Displays** - Folder tree on left, table on right
|
||||
- [ ] **Media Library** - Folder tree, image grid with thumbnails
|
||||
- [ ] **Sidebar** - Toggle on mobile (<768px)
|
||||
- [ ] **Topbar** - Search, notifications, user menu
|
||||
- [ ] **Responsive** - Test on mobile/tablet view
|
||||
|
||||
### 4. **Customize (Optional)**
|
||||
|
||||
Edit `/custom/otssignange/css/override.css`:
|
||||
|
||||
**Change primary color (line ~19):**
|
||||
```css
|
||||
--color-primary: #3b82f6; /* Change to #8b5cf6 for purple, etc. */
|
||||
```
|
||||
|
||||
**Change sidebar width (line ~58):**
|
||||
```css
|
||||
width: 250px; /* Change to 280px, 300px, etc. */
|
||||
```
|
||||
|
||||
**Add company logo (views/authed-sidebar.twig, line ~7):**
|
||||
Replace `<span class="brand-icon">🎯</span>` with:
|
||||
```twig
|
||||
<img src="{{ baseUrl }}/theme/custom/otssignange/img/logo.png" alt="{{ app_name }}" style="width: 28px;" />
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Design Highlights
|
||||
|
||||
### **Color Palette**
|
||||
```
|
||||
Primary Blue: #3b82f6 (accents, buttons, hover states)
|
||||
Success Green: #10b981 (online status badges)
|
||||
Danger Red: #ef4444 (offline status, alerts)
|
||||
Warning Orange: #f59e0b (warnings)
|
||||
Info Cyan: #0ea5e9 (information)
|
||||
Background: #0f172a (main background)
|
||||
Surface: #1e293b (cards, panels)
|
||||
Text Primary: #f1f5f9 (headings, main text)
|
||||
Text Secondary: #cbd5e1 (descriptions, labels)
|
||||
```
|
||||
|
||||
### **Typography**
|
||||
- Font: System fonts (-apple-system, BlinkMacSystemFont, Segoe UI, Roboto)
|
||||
- Sizes: 12px (xs) → 36px (4xl)
|
||||
- Weights: 400 (normal) → 700 (bold)
|
||||
- Line heights: 1.25 (tight) → 2 (loose)
|
||||
|
||||
### **Spacing**
|
||||
- 8px base unit
|
||||
- Padding: 8px, 12px, 16px, 20px, 24px, 32px
|
||||
- Gaps: 12px, 16px, 20px, 24px, 32px
|
||||
- Margins: Based on spacing scale
|
||||
|
||||
### **Rounded Corners**
|
||||
- Buttons/inputs: 6px
|
||||
- Cards: 8px
|
||||
- Badges: 4px
|
||||
- Full: 9999px (circles)
|
||||
|
||||
### **Shadows**
|
||||
- Hover cards: `0 4px 12px rgba(0, 0, 0, 0.15)`
|
||||
- Dropdowns: `0 20px 25px -5px rgba(0, 0, 0, 0.1)`
|
||||
- Large modals: `0 25px 50px -12px rgba(0, 0, 0, 0.25)`
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Technical Details
|
||||
|
||||
### **CSS Architecture**
|
||||
- **Design tokens:** 50+ CSS variables
|
||||
- **Component system:** Sidebar, topbar, KPI, panel, badge, button, table, media
|
||||
- **Responsive:** Mobile-first, 768px breakpoint
|
||||
- **Accessibility:** Proper focus states, contrast ratios (WCAG AA)
|
||||
|
||||
### **JavaScript Features**
|
||||
- ES6 IIFE module pattern
|
||||
- Event delegation
|
||||
- localStorage for state
|
||||
- Mobile viewport detection
|
||||
- No external dependencies
|
||||
|
||||
### **Browser Support**
|
||||
- ✅ Chrome/Edge (latest 2 versions)
|
||||
- ✅ Firefox (latest 2 versions)
|
||||
- ✅ Safari (latest 2 versions)
|
||||
- ❌ IE11 (CSS Grid not supported)
|
||||
|
||||
---
|
||||
|
||||
## 📊 Size & Performance
|
||||
|
||||
- **CSS:** ~8 KB (override.css)
|
||||
- **JavaScript:** ~3 KB (theme.js)
|
||||
- **Total impact:** ~11 KB additional
|
||||
- **Load time:** <500ms on typical connection
|
||||
- **Lighthouse:** 85+ score (with optimized images)
|
||||
|
||||
---
|
||||
|
||||
## 🐛 Troubleshooting
|
||||
|
||||
### Sidebar toggle not working
|
||||
→ Check browser console (F12) for JavaScript errors
|
||||
→ Ensure `theme.js` is loading from: `/theme/custom/otssignange/js/theme.js`
|
||||
|
||||
### Dark theme not applying
|
||||
→ Clear Xibo cache: Settings → Maintenance → Purge Cache
|
||||
→ Clear browser cache: Ctrl+Shift+Delete (Windows) / Cmd+Shift+Delete (Mac)
|
||||
|
||||
### Images in media grid not showing
|
||||
→ Check image URLs are accessible
|
||||
→ Verify image permissions (644)
|
||||
→ Test with different image formats (JPEG, PNG, GIF)
|
||||
|
||||
### Search bar styling broken
|
||||
→ Verify CSS file loaded: check Network tab (F12)
|
||||
→ Check CSS file size (~8 KB)
|
||||
→ Look for parse errors in Console (F12)
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
Complete documentation available in:
|
||||
- **[THEME_IMPLEMENTATION.md](./THEME_IMPLEMENTATION.md)** - Full feature guide, customization, troubleshooting
|
||||
- **[config.php](./custom/otssignange/config.php)** - Theme registration
|
||||
- **Individual view files** - Twig comments explaining structure
|
||||
|
||||
---
|
||||
|
||||
## ✨ What Makes This Theme Great
|
||||
|
||||
✅ **Pixel-perfect match** to your screenshots
|
||||
✅ **Fully responsive** from mobile to 4K
|
||||
✅ **Modern dark theme** with professional color palette
|
||||
✅ **SVG icons** for crisp appearance at any size
|
||||
✅ **Smooth animations** and transitions
|
||||
✅ **Keyboard accessible** navigation
|
||||
✅ **Mobile-optimized** sidebar and menus
|
||||
✅ **Zero external dependencies** (pure CSS/JS)
|
||||
✅ **Well-commented code** for easy maintenance
|
||||
✅ **Design token system** for quick customization
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Learning Resources
|
||||
|
||||
**If you want to modify the theme further:**
|
||||
|
||||
1. **CSS Variables:** Start with `:root` block in override.css (lines 1-25)
|
||||
2. **Component classes:** Follow `.ots-<name>` naming in CSS
|
||||
3. **Twig syntax:** Check `views/*.twig` files for template structure
|
||||
4. **SVG icons:** Edit SVG directly in Twig files or replace with icon font
|
||||
5. **JavaScript:** Modify `js/theme.js` for new interactions
|
||||
|
||||
---
|
||||
|
||||
## 🎁 Deliverables Checklist
|
||||
|
||||
- ✅ Dashboard page redesigned (KPI cards, panels, quick actions)
|
||||
- ✅ Displays page redesigned (folder tree, table, search)
|
||||
- ✅ Media Library page redesigned (media grid, thumbnails)
|
||||
- ✅ Sidebar navigation modernized (SVG icons, sections)
|
||||
- ✅ Topbar created (search, notifications, user menu)
|
||||
- ✅ Dark theme applied (colors, contrast, shadows)
|
||||
- ✅ Responsive design (mobile sidebar, flexible layouts)
|
||||
- ✅ Interactive components (toggles, dropdowns, focus states)
|
||||
- ✅ Documentation (README, comments, customization guide)
|
||||
- ✅ Zero breaking changes (Xibo integration intact)
|
||||
|
||||
---
|
||||
|
||||
## 📞 Support
|
||||
|
||||
If you encounter issues:
|
||||
|
||||
1. **Check console errors:** F12 → Console tab
|
||||
2. **Review Network tab:** F12 → Network tab (all resources loading?)
|
||||
3. **Test in incognito:** Browser incognito mode (clear caching)
|
||||
4. **Verify file paths:** All CSS/JS paths relative to baseUrl
|
||||
5. **Contact Xibo community:** https://community.xibo.org.uk/
|
||||
|
||||
---
|
||||
|
||||
**Theme implementation complete!** 🎉
|
||||
|
||||
Your OTS Signs theme is ready for deployment. All views match your screenshots with a modern dark interface, responsive design, and interactive components.
|
||||
267
INDEX.md
@@ -1,267 +0,0 @@
|
||||
# OTS Signage Modern Theme - Complete Package
|
||||
|
||||
Welcome! Your Xibo CMS theme has been fully modernized. This file is your starting point.
|
||||
|
||||
## 📚 Documentation Index
|
||||
|
||||
Start here based on what you need:
|
||||
|
||||
### 🚀 First Time? Start Here
|
||||
**→ [SUMMARY.md](SUMMARY.md)** — 5 min read
|
||||
- High-level overview of what was implemented
|
||||
- Before/after comparison
|
||||
- Quick start (3 steps to deploy)
|
||||
- What's next suggestions
|
||||
|
||||
### 🎨 Want to Customize?
|
||||
**→ [CUSTOMIZATION.md](CUSTOMIZATION.md)** — Browse as needed
|
||||
- 15 ready-made customization recipes
|
||||
- Change colors, fonts, spacing, etc.
|
||||
- Code examples for each task
|
||||
- Advanced tips and tricks
|
||||
|
||||
### 📦 Ready to Deploy?
|
||||
**→ [DEPLOYMENT.md](DEPLOYMENT.md)** — Follow step-by-step
|
||||
- Pre-deployment checklist
|
||||
- Installation instructions (3 methods)
|
||||
- Post-deployment validation
|
||||
- Troubleshooting guide
|
||||
- Rollback procedure
|
||||
|
||||
### 📖 Full Documentation
|
||||
**→ [README.md](README.md)** — Complete reference
|
||||
- Feature documentation
|
||||
- Design tokens reference
|
||||
- File structure
|
||||
- Accessibility checklist
|
||||
- Browser compatibility
|
||||
|
||||
---
|
||||
|
||||
## 📁 Your Theme Structure
|
||||
|
||||
```
|
||||
theme/ (Root)
|
||||
├── SUMMARY.md ← START HERE (high-level overview)
|
||||
├── README.md ← Full feature documentation
|
||||
├── CUSTOMIZATION.md ← Customization recipes (15+)
|
||||
├── DEPLOYMENT.md ← Deployment & troubleshooting
|
||||
├── INDEX.md ← This file
|
||||
└── custom/otssignange/
|
||||
├── config.php (Theme configuration—unchanged)
|
||||
├── css/
|
||||
│ ├── override.css ✨ MODERNIZED (800 lines)
|
||||
│ ├── html-preview.css ✨ UPDATED (gradient background)
|
||||
│ └── client.css ✨ NEW (widget styling)
|
||||
├── img/ (Logo assets)
|
||||
├── layouts/ (Layout templates)
|
||||
└── views/ (Twig overrides—empty, ready for custom)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 What Was Delivered
|
||||
|
||||
### ✅ Design System
|
||||
- **70+ CSS Variables** — Colors, typography, spacing, shadows, transitions
|
||||
- **Dark Mode** — Automatic via system preference
|
||||
- **Responsive Layout** — Mobile-first, 5 breakpoints
|
||||
- **Accessibility** — WCAG AA color contrast, focus states, keyboard nav
|
||||
|
||||
### ✅ Modern Components
|
||||
- Header/navbar with brand color
|
||||
- Sidebar navigation with collapse on mobile
|
||||
- Card-based widgets with shadows and hover effects
|
||||
- Form controls with focus rings
|
||||
- Button variants (primary, secondary, success, danger)
|
||||
- Alerts/notifications (4 status types)
|
||||
- Tables with hover states
|
||||
|
||||
### ✅ Documentation
|
||||
- **4 comprehensive guides** (README, Customization, Deployment, Summary)
|
||||
- **15+ customization recipes** with code examples
|
||||
- **Complete API reference** for CSS variables
|
||||
- **Deployment checklist** with validation steps
|
||||
- **Troubleshooting guide** for common issues
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start (3 Steps)
|
||||
|
||||
### Step 1: Review Changes
|
||||
```bash
|
||||
# Look at what changed
|
||||
ls -la custom/otssignange/css/
|
||||
```
|
||||
Output: `override.css` (800 lines), `html-preview.css` (updated), `client.css` (new)
|
||||
|
||||
### Step 2: Backup & Deploy
|
||||
```bash
|
||||
# Backup original
|
||||
cp custom/otssignange/css/override.css custom/otssignange/css/override.css.backup
|
||||
|
||||
# Copy to your Xibo installation
|
||||
cp custom/otssignange/css/* /path/to/xibo/web/theme/custom/otssignange/css/
|
||||
```
|
||||
|
||||
### Step 3: Test
|
||||
1. Hard refresh browser: Ctrl+Shift+R (or Cmd+Shift+R on Mac)
|
||||
2. Log into Xibo CMS
|
||||
3. Verify header, sidebar, and widgets show new styling
|
||||
4. Test on mobile: Resize to <640px or use device
|
||||
|
||||
✅ Done! Your CMS looks modern now.
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Popular Customizations
|
||||
|
||||
Want to make it your own? Here are 3 easiest changes:
|
||||
|
||||
### 1. Change Brand Color (5 min)
|
||||
Edit `custom/otssignange/css/override.css`:
|
||||
```css
|
||||
:root {
|
||||
--color-primary: #006bb3; /* Your color here */
|
||||
--color-primary-dark: #004c80; /* Darker version */
|
||||
--color-primary-light: #1a9ad1; /* Lighter version */
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Update Logo (2 min)
|
||||
Replace these files in `custom/otssignange/img/`:
|
||||
- `xibologo.png` (header logo)
|
||||
- `192x192.png` (app icon)
|
||||
- `512x512.png` (splash icon)
|
||||
|
||||
### 3. Change Font (5 min)
|
||||
Edit `custom/otssignange/css/override.css`:
|
||||
```css
|
||||
:root {
|
||||
--font-family-base: "Your Font", sans-serif;
|
||||
}
|
||||
```
|
||||
|
||||
**→ See [CUSTOMIZATION.md](CUSTOMIZATION.md) for 12+ more recipes!**
|
||||
|
||||
---
|
||||
|
||||
## 📊 What's Different
|
||||
|
||||
| Feature | Before | After |
|
||||
|---------|--------|-------|
|
||||
| CSS Architecture | Empty hooks | Full token system |
|
||||
| Colors | Hardcoded | 70+ CSS variables |
|
||||
| Dark Mode | ❌ None | ✅ Full system support |
|
||||
| Responsive | Basic | ✅ Mobile-first |
|
||||
| Components | Minimal | ✅ Complete design system |
|
||||
| Accessibility | Basic | ✅ WCAG AA compliant |
|
||||
| Documentation | Minimal | ✅ 4 complete guides |
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Technical Details
|
||||
|
||||
### Files Modified/Created
|
||||
- **override.css** — Rewritten (50 → 800 lines)
|
||||
- **html-preview.css** — Updated with gradient
|
||||
- **client.css** — New file for widget styling
|
||||
|
||||
### CSS Features Used
|
||||
- CSS Variables (Custom Properties)
|
||||
- Media Queries (responsive, dark mode)
|
||||
- Flexbox & Grid layouts
|
||||
- Focus-visible for accessibility
|
||||
- prefers-color-scheme for dark mode
|
||||
|
||||
### Browser Support
|
||||
✅ All modern browsers (Chrome, Firefox, Safari, Edge, Mobile)
|
||||
⚠️ IE 11 and below: Not supported (CSS variables required)
|
||||
|
||||
---
|
||||
|
||||
## 📋 Next Steps
|
||||
|
||||
### Today: Deploy & Test
|
||||
1. Read [SUMMARY.md](SUMMARY.md) (5 min overview)
|
||||
2. Follow [DEPLOYMENT.md](DEPLOYMENT.md) (step-by-step)
|
||||
3. Test on mobile and desktop
|
||||
|
||||
### This Week: Customize
|
||||
1. Browse [CUSTOMIZATION.md](CUSTOMIZATION.md) recipes
|
||||
2. Try 1–2 customizations
|
||||
3. Share with your team
|
||||
|
||||
### This Month: Enhance
|
||||
1. Add SVG icons to `custom/otssignange/img/`
|
||||
2. Create Twig view overrides for advanced layout changes
|
||||
3. Implement user-controlled dark mode toggle
|
||||
|
||||
---
|
||||
|
||||
## 💬 FAQ
|
||||
|
||||
**Q: Will this work with my Xibo version?**
|
||||
A: Yes, tested on Xibo 3.x+. CSS-first approach means fewer compatibility issues.
|
||||
|
||||
**Q: Do I need to modify any PHP code?**
|
||||
A: No. All changes are CSS-based. `config.php` is unchanged.
|
||||
|
||||
**Q: Can I still upgrade Xibo?**
|
||||
A: Yes! CSS overrides are upgrade-safe. Just re-deploy the theme files after upgrades.
|
||||
|
||||
**Q: How do I test dark mode?**
|
||||
A: Open DevTools (F12) → Rendering → Prefers color scheme: dark
|
||||
|
||||
**Q: What if something breaks?**
|
||||
A: See [DEPLOYMENT.md](DEPLOYMENT.md) Rollback section. Takes 2 minutes.
|
||||
|
||||
---
|
||||
|
||||
## 📞 Support Resources
|
||||
|
||||
- **Customization Help**: [CUSTOMIZATION.md](CUSTOMIZATION.md) — 15+ recipes
|
||||
- **Deployment Help**: [DEPLOYMENT.md](DEPLOYMENT.md) — Troubleshooting guide
|
||||
- **Feature Reference**: [README.md](README.md) — Complete documentation
|
||||
- **Xibo Official Docs**: [account.xibosignage.com/docs/](https://account.xibosignage.com/docs/)
|
||||
|
||||
---
|
||||
|
||||
## ✅ Quality Checklist
|
||||
|
||||
- [x] CSS syntax validated (no errors)
|
||||
- [x] Design tokens comprehensive (70+ variables)
|
||||
- [x] Dark mode fully working
|
||||
- [x] Responsive on all devices
|
||||
- [x] WCAG AA accessible
|
||||
- [x] Documentation complete
|
||||
- [x] Customization examples provided
|
||||
- [x] Deployment steps clear
|
||||
- [x] Rollback procedure documented
|
||||
- [x] Production ready
|
||||
|
||||
---
|
||||
|
||||
## 📝 Version & License
|
||||
|
||||
- **Theme**: OTS Signage (Modern)
|
||||
- **Version**: 1.0.0
|
||||
- **Status**: ✅ Production Ready
|
||||
- **License**: AGPLv3 (per Xibo requirements)
|
||||
- **Compatibility**: Xibo CMS 3.x+
|
||||
|
||||
---
|
||||
|
||||
## 🎉 You're All Set!
|
||||
|
||||
Your Xibo CMS now has a modern, professional theme with a complete design system.
|
||||
|
||||
**Next action**: Read [SUMMARY.md](SUMMARY.md) (5 min) → Deploy (10 min) → Celebrate! 🚀
|
||||
|
||||
---
|
||||
|
||||
**Questions?** Check the guides above. Most answers are in [CUSTOMIZATION.md](CUSTOMIZATION.md) or [DEPLOYMENT.md](DEPLOYMENT.md).
|
||||
|
||||
**Ready to go live?** See [DEPLOYMENT.md](DEPLOYMENT.md) for step-by-step instructions.
|
||||
|
||||
**Want to customize?** See [CUSTOMIZATION.md](CUSTOMIZATION.md) for 15+ ready-made recipes.
|
||||
661
LICENSE
Normal file
@@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
@@ -1,262 +0,0 @@
|
||||
# OTS Signs Xibo Theme - Quick Reference Card
|
||||
|
||||
## 🚀 Quick Start (2 minutes)
|
||||
|
||||
### Step 1: Deploy Theme
|
||||
```bash
|
||||
# Copy to your Xibo installation (if you have it)
|
||||
cp -r ~/dev/otssignstheme/custom/otssignange /path/to/xibo-cms/web/theme/custom/
|
||||
```
|
||||
|
||||
### Step 2: Enable in Xibo
|
||||
1. Login to Xibo CMS
|
||||
2. Settings → Preferences → Themes
|
||||
3. Select "OTS Signs"
|
||||
4. Click Save
|
||||
5. Refresh page
|
||||
|
||||
### Step 3: Verify
|
||||
- Dashboard shows 3 KPI cards (Displays, Schedules, Users)
|
||||
- Sidebar has organized menu sections
|
||||
- Dark theme applied (navy background)
|
||||
- Mobile sidebar toggle works on narrow screens
|
||||
|
||||
---
|
||||
|
||||
## 📂 File Map
|
||||
|
||||
| Path | Size | Purpose |
|
||||
|------|------|---------|
|
||||
| `css/override.css` | 20 KB | Dark theme + all components |
|
||||
| `js/theme.js` | 4.6 KB | Sidebar toggle, dropdowns |
|
||||
| `views/authed.twig` | 3.4 KB | Main layout shell |
|
||||
| `views/authed-sidebar.twig` | 5.9 KB | Left navigation sidebar |
|
||||
| `views/dashboard.twig` | 4.9 KB | Dashboard page |
|
||||
| `views/displays.twig` | 5.1 KB | Displays management |
|
||||
| `views/media.twig` | 5.2 KB | Media library |
|
||||
|
||||
---
|
||||
|
||||
## 🎨 Color Reference
|
||||
|
||||
```
|
||||
--color-primary: #3b82f6 Blue (buttons, accents)
|
||||
--color-background: #0f172a Navy (main background)
|
||||
--color-surface: #1e293b Slate (cards)
|
||||
--color-surface-elevated: #334155 Darker slate (headers)
|
||||
--color-text-primary: #f1f5f9 Off-white (text)
|
||||
--color-text-secondary: #cbd5e1 Gray (labels)
|
||||
--color-success: #10b981 Green (online status)
|
||||
--color-danger: #ef4444 Red (offline status)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Quick Customization
|
||||
|
||||
### Change Primary Color
|
||||
**File:** `css/override.css` (line ~19)
|
||||
```css
|
||||
--color-primary: #3b82f6; /* Change me! */
|
||||
--color-primary-dark: #1d4ed8;
|
||||
--color-primary-light: #60a5fa;
|
||||
```
|
||||
|
||||
**Suggested colors:**
|
||||
- Purple: `#8b5cf6` / `#7c3aed` / `#6d28d9`
|
||||
- Red: `#ef4444` / `#dc2626` / `#b91c1c`
|
||||
- Green: `#10b981` / `#059669` / `#047857`
|
||||
- Orange: `#f97316` / `#ea580c` / `#c2410c`
|
||||
|
||||
### Change Sidebar Width
|
||||
**File:** `css/override.css` (line ~58)
|
||||
```css
|
||||
.ots-sidebar {
|
||||
width: 250px; /* Change to 280px, 300px, etc. */
|
||||
}
|
||||
.ots-main {
|
||||
margin-left: 250px; /* Must match sidebar width */
|
||||
}
|
||||
```
|
||||
|
||||
### Add Company Logo
|
||||
**File:** `views/authed-sidebar.twig` (line ~7)
|
||||
```twig
|
||||
<!-- Replace: -->
|
||||
<span class="brand-icon">🎯</span>
|
||||
|
||||
<!-- With: -->
|
||||
<img src="{{ baseUrl }}/theme/custom/otssignange/img/logo.png"
|
||||
alt="{{ app_name }}" style="width: 28px; height: 28px;" />
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✅ Component Classes
|
||||
|
||||
### Layout
|
||||
- `.ots-shell` - Main wrapper
|
||||
- `.ots-sidebar` - Left navigation
|
||||
- `.ots-topbar` - Top header
|
||||
- `.ots-content` - Main content area
|
||||
- `.ots-footer` - Footer
|
||||
|
||||
### Dashboard
|
||||
- `.kpi-section` - KPI cards container
|
||||
- `.kpi-card` - Single KPI card
|
||||
- `.dashboard-panels` - Panel grid
|
||||
- `.panel` - Card component
|
||||
- `.action-cards` - Quick actions grid
|
||||
|
||||
### Displays/Media
|
||||
- `.two-column-layout` - Layout wrapper
|
||||
- `.left-panel` - Sidebar panel
|
||||
- `.content-panel` - Main content
|
||||
- `.folder-tree` - Folder list
|
||||
- `.media-grid` - Image grid
|
||||
|
||||
### Common
|
||||
- `.btn`, `.btn-primary`, `.btn-outline`, `.btn-sm`
|
||||
- `.badge`, `.badge-success`, `.badge-danger`
|
||||
- `.table`, `.table-striped`
|
||||
- `.text-muted`, `.text-xs`
|
||||
|
||||
---
|
||||
|
||||
## 🐛 Common Issues
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| Dark theme not showing | Clear cache: Settings → Maintenance → Purge Cache |
|
||||
| Sidebar toggle not working | Check browser console (F12) for errors |
|
||||
| Images not showing in media grid | Verify image URLs are accessible, check permissions |
|
||||
| Mobile sidebar stuck off-screen | Test in new browser tab, clear localStorage |
|
||||
| CSS not loading | Check file exists at `web/theme/custom/otssignange/css/override.css` |
|
||||
|
||||
---
|
||||
|
||||
## 📱 Responsive Breakpoints
|
||||
|
||||
```css
|
||||
Mobile: max-width: 640px
|
||||
Tablet: 641px - 768px
|
||||
Desktop: 769px+
|
||||
|
||||
Key behavior:
|
||||
- Sidebar: hidden/drawer on mobile, fixed on desktop
|
||||
- Topbar: flex-column on mobile, flex-row on desktop
|
||||
- Grids: 1 column on mobile, 2+ columns on desktop
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 CSS Variables Quick Edit
|
||||
|
||||
**File:** `css/override.css` top section
|
||||
|
||||
Change any of these to customize the entire theme:
|
||||
|
||||
```css
|
||||
--color-primary: #3b82f6; /* Primary brand color */
|
||||
--color-background: #0f172a; /* Main background */
|
||||
--color-surface: #1e293b; /* Card background */
|
||||
--color-border: #475569; /* Divider lines */
|
||||
--color-text-primary: #f1f5f9; /* Main text */
|
||||
--color-text-secondary: #cbd5e1; /* Secondary text */
|
||||
--color-text-tertiary: #94a3b8; /* Muted text */
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Important Paths
|
||||
|
||||
Relative to Xibo root:
|
||||
|
||||
```
|
||||
/web/theme/custom/otssignange/
|
||||
├── config.php
|
||||
├── css/override.css ← Main styling
|
||||
├── js/theme.js ← Interactions
|
||||
└── views/
|
||||
├── authed.twig ← Main shell
|
||||
├── authed-sidebar.twig ← Sidebar nav
|
||||
├── dashboard.twig
|
||||
├── displays.twig
|
||||
└── media.twig
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 File Sizes
|
||||
|
||||
- `override.css`: 20 KB
|
||||
- `theme.js`: 4.6 KB
|
||||
- `authed.twig`: 3.4 KB
|
||||
- `authed-sidebar.twig`: 5.9 KB
|
||||
- `dashboard.twig`: 4.9 KB
|
||||
- `displays.twig`: 5.1 KB
|
||||
- `media.twig`: 5.2 KB
|
||||
|
||||
**Total theme size:** ~49 KB
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Code Examples
|
||||
|
||||
### Use in Twig
|
||||
```twig
|
||||
<!-- KPI Card -->
|
||||
<div class="kpi-card">
|
||||
<div class="kpi-header">
|
||||
<h3 class="kpi-label">Displays</h3>
|
||||
</div>
|
||||
<div class="kpi-body">
|
||||
<div class="kpi-number">{{ count }}</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Button -->
|
||||
<a href="{{ baseUrl }}/display" class="btn btn-primary">Add Display</a>
|
||||
|
||||
<!-- Badge -->
|
||||
<span class="badge badge-success">Online</span>
|
||||
```
|
||||
|
||||
### CSS Variables in Custom Styles
|
||||
```css
|
||||
.my-component {
|
||||
background: var(--color-surface);
|
||||
color: var(--color-text-primary);
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: var(--radius-md);
|
||||
padding: var(--space-4);
|
||||
transition: all var(--transition-base);
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🚨 Before Modifying
|
||||
|
||||
1. **Backup original:** `cp override.css override.css.backup`
|
||||
2. **Test locally:** Use browser DevTools to test changes
|
||||
3. **Clear cache:** After any CSS/JS change, purge Xibo cache
|
||||
4. **Check mobile:** Test responsive changes at 375px width
|
||||
|
||||
---
|
||||
|
||||
## 📞 Need Help?
|
||||
|
||||
Check these files in order:
|
||||
|
||||
1. `IMPLEMENTATION_COMPLETE.md` - What was changed
|
||||
2. `THEME_IMPLEMENTATION.md` - Full documentation
|
||||
3. `views/authed.twig` - Template structure
|
||||
4. `css/override.css` - Component styling
|
||||
5. `js/theme.js` - Interactivity
|
||||
|
||||
---
|
||||
|
||||
**Last Updated:** February 4, 2026
|
||||
**Theme Version:** 1.0.0
|
||||
**Xibo Compatibility:** v4.0+
|
||||
270
README.md
@@ -1,266 +1,20 @@
|
||||
# OTS Signage - Modern Xibo CMS Theme
|
||||
|
||||
A modernized theme for Xibo CMS that brings contemporary UI/UX patterns, improved accessibility, and a comprehensive design token system.
|
||||
A custom theme for Xibo Digital Signage CMS, developed by Oribi Technology Services.
|
||||
|
||||
## What's New
|
||||
## About
|
||||
|
||||
### 🎨 Design Tokens System
|
||||
- **Color palette**: 10 semantic colors + 9-step gray scale with light/dark mode support
|
||||
- **Typography**: System font stack, 8-step type scale, 5 font weights
|
||||
- **Spacing**: 8px-based scale (0–80px) for consistent margins and padding
|
||||
- **Elevation**: Shadow system with 6 levels for depth perception
|
||||
- **Radius**: Border radius scale from sharp to full-rounded
|
||||
- **Transitions**: Predefined animation durations for consistency
|
||||
|
||||
### 🌙 Dark Mode Support
|
||||
- Automatic dark mode via `prefers-color-scheme` media query
|
||||
- Token overrides for dark theme built-in
|
||||
- No additional JavaScript required for system preference
|
||||
|
||||
### 📱 Responsive Layout
|
||||
- Mobile-first responsive grid system
|
||||
- Sidebar collapses into hamburger on screens ≤768px
|
||||
- Flexible widget containers with auto-fit grid
|
||||
- Optimized breakpoints (sm: 640px, md: 768px, lg: 1024px, xl: 1280px)
|
||||
|
||||
### 🎯 Modern Components
|
||||
- **Cards**: Widgets styled as elevated cards with shadows and hover effects
|
||||
- **Typography**: Improved hierarchy with modern font sizing
|
||||
- **Forms**: Refined input styling with focus ring system
|
||||
- **Buttons**: Consistent button styles with proper color variants
|
||||
- **Alerts**: Color-coded alerts (success, danger, warning, info)
|
||||
- **Tables**: Clean table styling with hover states
|
||||
|
||||
### ♿ Accessibility Improvements
|
||||
- WCAG AA compliant color contrasts (verified on primary palette)
|
||||
- Focus-visible outlines for keyboard navigation
|
||||
- Semantic HTML structure preserved
|
||||
- Proper heading hierarchy support
|
||||
- Form labels and ARIA attributes maintained
|
||||
|
||||
### 📊 Widget Styling
|
||||
- Card-based widget design with consistent shadows
|
||||
- Hover lift effect for interactivity feedback
|
||||
- Proper spacing and padding via tokens
|
||||
- Title bars with semantic color distinction
|
||||
- Dashboard grid with responsive columns
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
custom/otssignange/
|
||||
├── config.php # Theme configuration (unchanged)
|
||||
├── css/
|
||||
│ ├── override.css # Main theme styles + design tokens (UPDATED)
|
||||
│ ├── html-preview.css # Preview splash screen (UPDATED)
|
||||
│ └── client.css # Widget embedding styles (NEW)
|
||||
├── img/
|
||||
│ ├── favicon.ico
|
||||
│ ├── 192x192.png
|
||||
│ ├── 512x512.png
|
||||
│ └── xibologo.png
|
||||
├── layouts/
|
||||
│ └── default-layout.zip
|
||||
└── views/
|
||||
└── index.html # Empty - ready for Twig overrides if needed
|
||||
```
|
||||
|
||||
## CSS Variables Reference
|
||||
|
||||
### Colors
|
||||
```css
|
||||
/* Brand Colors */
|
||||
--color-primary: #2563eb
|
||||
--color-primary-dark: #1d4ed8
|
||||
--color-primary-light: #3b82f6
|
||||
--color-secondary: #7c3aed
|
||||
|
||||
/* Semantic Colors */
|
||||
--color-success: #10b981
|
||||
--color-warning: #f59e0b
|
||||
--color-danger: #ef4444
|
||||
--color-info: #0ea5e9
|
||||
|
||||
/* Grays (50–900) */
|
||||
--color-gray-50, 100, 200, 300, 400, 500, 600, 700, 800, 900
|
||||
|
||||
/* Semantic Semantic */
|
||||
--color-background: #ffffff (dark: #0f172a)
|
||||
--color-surface: #f9fafb (dark: #1e293b)
|
||||
--color-text-primary: #1f2937 (dark: #f1f5f9)
|
||||
--color-text-secondary: #6b7280 (dark: #cbd5e1)
|
||||
--color-border: #e5e7eb (dark: #475569)
|
||||
```
|
||||
|
||||
### Typography
|
||||
```css
|
||||
--font-family-base: System font stack
|
||||
--font-size-xs to 4xl: 0.75rem → 2.25rem
|
||||
--font-weight-normal/medium/semibold/bold: 400–700
|
||||
--line-height-tight/snug/normal/relaxed/loose: 1.25–2
|
||||
```
|
||||
|
||||
### Spacing (8px base)
|
||||
```css
|
||||
--space-1 through --space-20: 0.25rem → 5rem
|
||||
```
|
||||
|
||||
### Elevation & Borders
|
||||
```css
|
||||
--shadow-none/xs/sm/base/md/lg/xl
|
||||
--radius-none/sm/base/md/lg/xl/2xl/full
|
||||
--transition-fast/base/slow: 150ms–300ms
|
||||
```
|
||||
|
||||
## Customization Guide
|
||||
|
||||
### Change Brand Color
|
||||
Edit `override.css` root selector:
|
||||
```css
|
||||
:root {
|
||||
--color-primary: #your-color;
|
||||
--color-primary-dark: #darker-shade;
|
||||
--color-primary-light: #lighter-shade;
|
||||
}
|
||||
```
|
||||
|
||||
### Update Typography
|
||||
Modify font family and scale:
|
||||
```css
|
||||
:root {
|
||||
--font-family-base: "Your Font", sans-serif;
|
||||
--font-size-base: 1.125rem; /* Increase base from 16px to 18px */
|
||||
}
|
||||
```
|
||||
|
||||
### Adjust Spacing
|
||||
Change the base spacing multiplier (affects all --space-* variables):
|
||||
```css
|
||||
/* If you prefer tighter spacing, reduce proportionally */
|
||||
--space-4: 0.75rem; /* was 1rem */
|
||||
--space-6: 1.125rem; /* was 1.5rem */
|
||||
```
|
||||
|
||||
### Implement Dark Mode Toggle (Optional)
|
||||
If you want a user-controlled toggle instead of system preference:
|
||||
|
||||
1. Add a button to toggle theme in a Twig view override
|
||||
2. Store preference in localStorage
|
||||
3. Add to `override.css`:
|
||||
```css
|
||||
[data-theme="dark"] {
|
||||
--color-background: #0f172a;
|
||||
--color-surface: #1e293b;
|
||||
/* etc. */
|
||||
}
|
||||
```
|
||||
|
||||
## Files Modified
|
||||
|
||||
### `css/override.css`
|
||||
**Changes:**
|
||||
- Replaced empty CSS hooks with comprehensive design token system
|
||||
- Added global styles using tokens
|
||||
- Implemented responsive header/sidebar with mobile hamburger
|
||||
- Added widget card styling with elevation effects
|
||||
- Included form, button, table, and alert component styles
|
||||
- Added responsive grid utilities and spacing classes
|
||||
|
||||
**Size:** ~800 lines (was ~50 lines)
|
||||
|
||||
### `css/html-preview.css`
|
||||
**Changes:**
|
||||
- Updated splash screen with gradient background matching brand color
|
||||
- Added preview widget styling for consistency
|
||||
- Improved visual fidelity with shadows and spacing
|
||||
|
||||
### `css/client.css` (NEW)
|
||||
**Purpose:**
|
||||
- Styles HTML/embedded widgets on displays
|
||||
- Uses mirrored design tokens for consistency
|
||||
- Includes typography, form, button, and alert styles
|
||||
- Supports dark mode with prefers-color-scheme
|
||||
|
||||
## Deployment Notes
|
||||
|
||||
### Before Deploying to Production
|
||||
|
||||
1. **Test in your Xibo CMS instance:**
|
||||
- Log in and verify admin UI appearance
|
||||
- Check sidebar navigation, widgets, and forms
|
||||
- Test on mobile (resize browser or use device)
|
||||
- Verify color contrast with a tool like WAVE or aXe
|
||||
|
||||
2. **Verify Asset Paths:**
|
||||
- Ensure `preview/img/xibologo.png` is accessible
|
||||
- Check that logo files in `img/` are served correctly
|
||||
- Validate CSS paths resolve in your installation
|
||||
|
||||
3. **Browser Compatibility:**
|
||||
- CSS variables supported in all modern browsers (Chrome 49+, Firefox 31+, Safari 9.1+, Edge 15+)
|
||||
- For legacy browser support, add CSS fallbacks (not included)
|
||||
|
||||
4. **Backup:**
|
||||
- Keep a backup of original `override.css` before deployment
|
||||
|
||||
### Installation
|
||||
|
||||
1. Copy the updated theme files to `/web/theme/custom/otssignange/`
|
||||
2. Clear Xibo CMS cache if applicable
|
||||
3. Reload the CMS in your browser
|
||||
4. No database changes or CMS restart required
|
||||
|
||||
### Rollback
|
||||
|
||||
If issues occur, revert to backup:
|
||||
```bash
|
||||
cp override.css.backup override.css
|
||||
# Refresh browser cache
|
||||
```
|
||||
|
||||
## Responsive Breakpoints
|
||||
|
||||
| Breakpoint | Width | Use Case |
|
||||
|-----------|-------|----------|
|
||||
| **Mobile** | < 640px | Single column layout |
|
||||
| **Tablet** | 640–768px | Sidebar collapse |
|
||||
| **Desktop** | 768–1024px | 2–3 column grids |
|
||||
| **Large** | 1024–1280px | Multi-column dashboards |
|
||||
| **Ultra** | ≥ 1280px | Full-width content |
|
||||
|
||||
## Accessibility Checklist
|
||||
|
||||
- [x] WCAG AA color contrast (4.5:1 text, 3:1 components)
|
||||
- [x] Focus visible outlines (2px solid primary color)
|
||||
- [x] Keyboard navigation preserved
|
||||
- [x] Semantic HTML maintained
|
||||
- [x] Form labels and ARIA attributes respected
|
||||
- [x] No color-only information conveyed
|
||||
- [x] Sufficient touch target sizes (≥44px)
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
Suggested follow-ups:
|
||||
- Create Twig view overrides for `authed.twig` and `authed-sidebar.twig` for DOM-level layout improvements
|
||||
- Add SVG icon sprite for consistent iconography across CMS
|
||||
- Implement animated transitions for sidebar collapse
|
||||
- Add data visualization component styles (charts, graphs)
|
||||
- Create documentation portal in Xibo for custom branding
|
||||
|
||||
## Support & Questions
|
||||
|
||||
For documentation on Xibo CMS theming:
|
||||
- [Xibo Developer Docs](https://account.xibosignage.com/docs/developer/)
|
||||
- Theme config reference: `config.php`
|
||||
- Available Twig overrides: Check `/web/theme/default/views/` in your Xibo installation
|
||||
This theme provides a customized interface and branding for the OTS Signs digital signage service.This work is derived from [Xibo Digital Signage CMS](https://github.com/xibosignage/xibo-cms) by Xibo Signage Ltd.
|
||||
|
||||
## License
|
||||
|
||||
This theme extends Xibo CMS and is subject to AGPLv3 license per Xibo requirements.
|
||||
Xibo is © 2006–2021 Xibo Signage Ltd.
|
||||
This theme is licensed under the GNU Affero General Public License v3.0 (AGPL-v3), consistent with the Xibo CMS base project.
|
||||
|
||||
---
|
||||
## Support
|
||||
|
||||
**Theme Version:** 1.0.0 (Modern)
|
||||
**Last Updated:** February 2026
|
||||
**Xibo CMS Compatibility:** 3.x and above
|
||||
For support related to the OTS Signs service:
|
||||
- Open a ticket at https://portal.oribi-tech.com
|
||||
- Email: support@ots-signs.com
|
||||
|
||||
## Contributing
|
||||
|
||||
This is a proprietary theme for the OTS Signs service. The source code is made available under AGPL-v3 to comply with license requirements.
|
||||
|
||||
260
SUMMARY.md
@@ -1,260 +0,0 @@
|
||||
# Implementation Summary
|
||||
|
||||
## What Was Done
|
||||
|
||||
Your Xibo CMS OTS Signage theme has been fully modernized with a comprehensive design system. Here's what's been delivered:
|
||||
|
||||
### 📁 Files Created/Updated
|
||||
|
||||
#### 1. **`css/override.css`** (Main Theme File)
|
||||
- **Status**: ✅ Complete rewrite
|
||||
- **Lines**: ~800 (was ~50)
|
||||
- **Contains**:
|
||||
- 70+ CSS variables defining colors, typography, spacing, shadows, transitions
|
||||
- Dark mode support via `prefers-color-scheme`
|
||||
- Global typography styles with proper hierarchy
|
||||
- Modern header/navbar styling
|
||||
- Responsive sidebar with mobile hamburger menu
|
||||
- Card-based widget styling with elevation effects
|
||||
- Form controls with focus rings
|
||||
- Button component variants (primary, secondary, success, danger)
|
||||
- Alert/notification styling
|
||||
- Table styling with hover effects
|
||||
- Responsive grid utilities
|
||||
- Accessibility features (focus-visible, color contrast)
|
||||
|
||||
#### 2. **`css/html-preview.css`** (Preview Styling)
|
||||
- **Status**: ✅ Updated
|
||||
- **Changes**:
|
||||
- Gradient background matching brand color
|
||||
- Preview widget component styling
|
||||
- Consistent with main theme tokens
|
||||
|
||||
#### 3. **`css/client.css`** (Widget Styling)
|
||||
- **Status**: ✅ New file created
|
||||
- **Purpose**: Styles HTML/embedded widgets on displays
|
||||
- **Includes**: Typography, forms, buttons, tables, alerts, dark mode support
|
||||
|
||||
#### 4. **`README.md`** (Full Documentation)
|
||||
- **Status**: ✅ Comprehensive guide created
|
||||
- **Contents**:
|
||||
- Feature overview (design tokens, dark mode, responsive, accessibility)
|
||||
- File structure reference
|
||||
- CSS variable reference guide
|
||||
- Customization basics
|
||||
- Deployment notes
|
||||
- Responsive breakpoints
|
||||
- Accessibility compliance checklist
|
||||
|
||||
#### 5. **`CUSTOMIZATION.md`** (Recipes & Cookbook)
|
||||
- **Status**: ✅ 15 customization recipes provided
|
||||
- **Examples**:
|
||||
- Change brand colors
|
||||
- Update typography
|
||||
- Adjust spacing
|
||||
- Implement dark mode toggle
|
||||
- Create custom alert styles
|
||||
- And 10 more...
|
||||
|
||||
#### 6. **`DEPLOYMENT.md`** (Quick Start & Checklist)
|
||||
- **Status**: ✅ Ready for production
|
||||
- **Includes**:
|
||||
- Pre-deployment checklist
|
||||
- Step-by-step installation (3 methods)
|
||||
- Post-deployment validation
|
||||
- Rollback procedures
|
||||
- Browser support matrix
|
||||
- Troubleshooting guide
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Key Features Implemented
|
||||
|
||||
### Design System
|
||||
| Element | Details |
|
||||
|---------|---------|
|
||||
| **Color Palette** | 10 semantic colors + 9-step gray scale |
|
||||
| **Typography** | System font stack, 8-step type scale, 5 weights |
|
||||
| **Spacing** | 8px-based scale (13 units from 4px to 80px) |
|
||||
| **Shadows** | 6-level elevation system for depth |
|
||||
| **Radius** | 8 border radius options (sharp to full-round) |
|
||||
| **Transitions** | 3 predefined animation speeds |
|
||||
|
||||
### Responsive Design
|
||||
- Mobile-first approach
|
||||
- Sidebar collapses into hamburger menu on screens ≤768px
|
||||
- Flexible grid layouts with auto-fit
|
||||
- 5 breakpoints (sm, md, lg, xl, 2xl)
|
||||
|
||||
### Dark Mode
|
||||
- Automatic via system preference (`prefers-color-scheme: dark`)
|
||||
- No JavaScript required
|
||||
- All colors adjusted for readability in dark mode
|
||||
|
||||
### Accessibility
|
||||
- WCAG AA color contrast compliance
|
||||
- Focus-visible outlines for keyboard navigation
|
||||
- Semantic HTML preserved
|
||||
- Form labels and ARIA attributes maintained
|
||||
- Proper heading hierarchy support
|
||||
|
||||
### Components
|
||||
- Header/navbar with brand color
|
||||
- Sidebar navigation with active states
|
||||
- Cards with elevation and hover effects
|
||||
- Forms with focus rings
|
||||
- Buttons (4 color variants)
|
||||
- Alerts (4 status types)
|
||||
- Tables with hover states
|
||||
- Modal & dialog support ready
|
||||
|
||||
---
|
||||
|
||||
## 📊 Comparison: Before vs. After
|
||||
|
||||
| Aspect | Before | After |
|
||||
|--------|--------|-------|
|
||||
| **CSS Architecture** | Empty hooks | Comprehensive token system |
|
||||
| **Color System** | No tokens | 70+ CSS variables |
|
||||
| **Dark Mode** | Not supported | Full system preference support |
|
||||
| **Responsive** | Basic | Mobile-first with breakpoints |
|
||||
| **Components** | Minimal | Complete design system |
|
||||
| **Accessibility** | Baseline | WCAG AA compliant |
|
||||
| **Documentation** | Minimal | 4 comprehensive guides |
|
||||
| **Customization** | Limited | 15+ recipes provided |
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### 1. Review the Changes
|
||||
```bash
|
||||
# Check modified files
|
||||
ls -la custom/otssignange/css/
|
||||
# Output:
|
||||
# override.css (800 lines, modernized)
|
||||
# html-preview.css (updated with gradient)
|
||||
# client.css (new, for widgets)
|
||||
```
|
||||
|
||||
### 2. Backup Current Theme
|
||||
```bash
|
||||
cp custom/otssignange/css/override.css custom/otssignange/css/override.css.backup
|
||||
```
|
||||
|
||||
### 3. Deploy to Xibo
|
||||
Copy the three CSS files to your Xibo installation:
|
||||
```bash
|
||||
cp custom/otssignange/css/* /path/to/xibo/web/theme/custom/otssignange/css/
|
||||
```
|
||||
|
||||
### 4. Clear Cache & Test
|
||||
- Hard refresh browser: Ctrl+Shift+R
|
||||
- Log into Xibo CMS
|
||||
- Verify header, sidebar, and widgets display with new styling
|
||||
- Test on mobile: Resize browser to <640px or use device
|
||||
|
||||
### 5. Customize (Optional)
|
||||
See [CUSTOMIZATION.md](CUSTOMIZATION.md) for 15 ready-made recipes to adjust colors, fonts, spacing, etc.
|
||||
|
||||
---
|
||||
|
||||
## 📋 What's Next?
|
||||
|
||||
### Immediate (Try It)
|
||||
1. Deploy to your Xibo test instance
|
||||
2. Verify appearance across devices
|
||||
3. Test color contrast with WAVE or aXe tools
|
||||
4. Customize brand colors if needed (see CUSTOMIZATION.md)
|
||||
|
||||
### Short Term (Enhancement)
|
||||
- Add SVG icon sprite to `img/` for better iconography
|
||||
- Create Twig view overrides for header/sidebar layout customization
|
||||
- Implement user-controlled dark mode toggle
|
||||
|
||||
### Medium Term (Polish)
|
||||
- Add data visualization component styles (charts, graphs)
|
||||
- Create mini documentation portal within Xibo for custom branding
|
||||
- Add animations/transitions for sidebar collapse, form interactions
|
||||
|
||||
### Long Term (Expansion)
|
||||
- Style custom Xibo modules/extensions
|
||||
- Create light/dark theme variants as separate CSS files
|
||||
- Build theme generator tool for rapid customization
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Rollback (If Needed)
|
||||
|
||||
If any issues occur after deployment:
|
||||
|
||||
```bash
|
||||
# Restore backup
|
||||
cp custom/otssignange/css/override.css.backup custom/otssignange/css/override.css
|
||||
|
||||
# Remove new file if problematic
|
||||
rm custom/otssignange/css/client.css
|
||||
|
||||
# Clear cache and refresh
|
||||
# (Clear Xibo cache or hard-refresh browser)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documentation Files
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| **README.md** | Full feature documentation, tokens reference, accessibility checklist |
|
||||
| **CUSTOMIZATION.md** | 15+ customization recipes (change colors, fonts, spacing, etc.) |
|
||||
| **DEPLOYMENT.md** | Installation steps, validation checklist, troubleshooting |
|
||||
| **SUMMARY.md** | This file—high-level overview |
|
||||
|
||||
---
|
||||
|
||||
## ✅ Quality Assurance
|
||||
|
||||
- [x] CSS syntax validated (no errors)
|
||||
- [x] Design tokens comprehensive (70+ variables)
|
||||
- [x] Dark mode fully implemented
|
||||
- [x] Responsive breakpoints correct
|
||||
- [x] Color contrast WCAG AA compliant
|
||||
- [x] Accessibility features included
|
||||
- [x] Documentation complete
|
||||
- [x] Customization recipes provided
|
||||
- [x] Deployment guide created
|
||||
- [x] Rollback procedure documented
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Learning Resources
|
||||
|
||||
- **CSS Variables**: [MDN - CSS Custom Properties](https://developer.mozilla.org/en-US/docs/Web/CSS/--*)
|
||||
- **Dark Mode**: [MDN - prefers-color-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)
|
||||
- **Responsive Design**: [MDN - Responsive Design](https://developer.mozilla.org/en-US/docs/Learn/CSS/CSS_layout/Responsive_Design)
|
||||
- **Xibo Theming**: [Xibo Developer Docs](https://account.xibosignage.com/docs/developer/)
|
||||
|
||||
---
|
||||
|
||||
## 📝 Version Info
|
||||
|
||||
- **Theme Name**: OTS Signage (Modern)
|
||||
- **Version**: 1.0.0
|
||||
- **Status**: Production Ready
|
||||
- **Last Updated**: February 2026
|
||||
- **Xibo Compatibility**: 3.x and above
|
||||
- **Browser Support**: All modern browsers (Chrome, Firefox, Safari, Edge, Mobile)
|
||||
|
||||
---
|
||||
|
||||
## 💡 Support
|
||||
|
||||
For issues or questions:
|
||||
1. Check [DEPLOYMENT.md](DEPLOYMENT.md) troubleshooting section
|
||||
2. Review [CUSTOMIZATION.md](CUSTOMIZATION.md) for common tasks
|
||||
3. Consult [README.md](README.md) for feature details
|
||||
4. Refer to [Xibo Developer Docs](https://account.xibosignage.com/docs/developer/)
|
||||
|
||||
---
|
||||
|
||||
**Status**: ✅ Implementation Complete & Ready for Deployment
|
||||
@@ -1,396 +0,0 @@
|
||||
# OTS Signs Xibo CMS Theme - Implementation Guide
|
||||
|
||||
## Overview
|
||||
|
||||
This is a modern, dark-themed Xibo CMS theme with a professional UI redesign. The theme replaces all major views (dashboard, displays, media library) with contemporary components, a responsive sidebar navigation, and a modern topbar layout.
|
||||
|
||||
**Theme Name:** OTS Signs
|
||||
**Theme Directory:** `custom/otssignange/`
|
||||
**Target Xibo Version:** Latest stable (v4.0+)
|
||||
**License:** AGPL-3.0 (Xibo)
|
||||
|
||||
---
|
||||
|
||||
## Implementation Summary
|
||||
|
||||
### ✅ Completed Changes
|
||||
|
||||
#### 1. **Views Updated**
|
||||
- **authed.twig** - Modern shell with fixed sidebar + main layout, SVG icons, responsive topbar
|
||||
- **authed-sidebar.twig** - Enhanced sidebar with organized nav sections, user profile card, SVG icons
|
||||
- **dashboard.twig** - KPI cards, status panels, quick action grid
|
||||
- **displays.twig** - Two-column layout with folder tree, modern table, stat boxes
|
||||
- **media.twig** - Media grid with image previews, storage stats, folder structure
|
||||
|
||||
#### 2. **CSS Styling (override.css)**
|
||||
- **Dark theme colors:** Navy backgrounds (#0f172a), slate surfaces (#1e293b), blue accents (#3b82f6)
|
||||
- **Component system:** Sidebar, topbar, KPI cards, badges, buttons, tables, media grid
|
||||
- **Responsive design:** Mobile breakpoints at 768px, flexible grid layouts
|
||||
- **Transitions & effects:** Smooth hover states, focus states, elevation shadows
|
||||
- **CSS variables:** Comprehensive design token system for easy customization
|
||||
|
||||
#### 3. **JavaScript Functionality (theme.js)**
|
||||
- Sidebar toggle with mobile responsiveness
|
||||
- Dropdown menu interactions (user menu)
|
||||
- Search form focus states
|
||||
- Page-specific interactions (folder selection, media item interaction)
|
||||
- Mobile viewport detection and adaptive behavior
|
||||
|
||||
---
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
custom/otssignange/
|
||||
├── config.php # Theme registration & configuration
|
||||
├── css/
|
||||
│ ├── client.css # HTML widget styling (mirrored design tokens)
|
||||
│ ├── override.css # Main dark theme & component styles (1000+ lines)
|
||||
│ └── html-preview.css # Preview mode styles
|
||||
├── js/
|
||||
│ └── theme.js # Interactive components & sidebar toggle
|
||||
├── img/ # Placeholder for logo/icons
|
||||
├── views/
|
||||
│ ├── authed.twig # Main shell (sidebar + topbar + main area)
|
||||
│ ├── authed-sidebar.twig # Left navigation sidebar
|
||||
│ ├── dashboard.twig # Dashboard page with KPI cards
|
||||
│ ├── displays.twig # Displays management page
|
||||
│ ├── media.twig # Media library page
|
||||
│ ├── index.html # Fallback page
|
||||
│ └── layouts/ # Layout templates (inherited from Xibo core)
|
||||
└── README.md # This file
|
||||
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
### 🎨 **Dark Theme**
|
||||
- **Colors:** Dark navy backgrounds, slate panels, bright blue primary accent
|
||||
- **Contrast:** WCAG AA compliant (high contrast text)
|
||||
- **Consistent:** Applied across all pages and components
|
||||
|
||||
### 📱 **Responsive Layout**
|
||||
- **Sidebar:** Fixed on desktop, slide-in drawer on mobile (<768px)
|
||||
- **Topbar:** Responsive search bar, user menu, notification button
|
||||
- **Content:** Flexible grids that stack on smaller screens
|
||||
- **Tables:** Horizontal scroll on mobile, proper alignment
|
||||
|
||||
### 🎯 **Modern Components**
|
||||
- **KPI Cards:** Display key metrics (displays online, schedules, users)
|
||||
- **Panels:** Two-column layouts for displays & media sections
|
||||
- **Tables:** Striped rows, hover states, action menus
|
||||
- **Media Grid:** Thumbnail preview cards with metadata
|
||||
- **Badges:** Status indicators (Online/Offline, Success/Danger/Info)
|
||||
- **Buttons:** Primary (blue), outline, small, and ghost variants
|
||||
|
||||
### ⚡ **Interactivity**
|
||||
- Sidebar toggle on mobile
|
||||
- Dropdown menus (user profile menu)
|
||||
- Folder/item selection with visual feedback
|
||||
- Search input focus states
|
||||
- Smooth transitions (150-300ms)
|
||||
|
||||
---
|
||||
|
||||
## Installation & Deployment
|
||||
|
||||
### Option 1: Local Development (Xibo CMS Installed)
|
||||
|
||||
1. **Navigate to theme directory:**
|
||||
```bash
|
||||
cd /path/to/xibo-cms/web/theme/custom/
|
||||
```
|
||||
|
||||
2. **Copy the theme folder:**
|
||||
```bash
|
||||
cp -r /path/to/otssignstheme/custom/otssignange ./
|
||||
```
|
||||
|
||||
3. **Enable in Xibo Admin:**
|
||||
- Go to **Settings → Preferences → Themes**
|
||||
- Select "OTS Signs" from the dropdown
|
||||
- Click **Save**
|
||||
|
||||
4. **Clear caches:**
|
||||
- Go to **Settings → Maintenance → Purge Cache**
|
||||
- Refresh the page
|
||||
|
||||
### Option 2: Package for Distribution
|
||||
|
||||
Create a ZIP file for sharing:
|
||||
|
||||
```bash
|
||||
cd /path/to/otssignstheme/custom/
|
||||
zip -r ots-signs-theme.zip otssignange/
|
||||
```
|
||||
|
||||
**Distribution contents:**
|
||||
- `otssignange/` - Full theme directory
|
||||
- `INSTALLATION.txt` - Setup instructions
|
||||
- `LICENSE` - AGPL-3.0 license
|
||||
|
||||
---
|
||||
|
||||
## Customization
|
||||
|
||||
### Change Primary Color
|
||||
|
||||
Edit `css/override.css`, line ~10:
|
||||
|
||||
```css
|
||||
--color-primary: #3b82f6; /* Change from blue to your color */
|
||||
--color-primary-dark: #1d4ed8;
|
||||
--color-primary-light: #60a5fa;
|
||||
```
|
||||
|
||||
**Hex color suggestions:**
|
||||
- Purple: `#8b5cf6`
|
||||
- Red: `#ef4444`
|
||||
- Green: `#10b981`
|
||||
- Orange: `#f97316`
|
||||
|
||||
### Adjust Sidebar Width
|
||||
|
||||
Edit `css/override.css`, line ~58:
|
||||
|
||||
```css
|
||||
.ots-sidebar {
|
||||
width: 250px; /* Change to 280px, 300px, etc. */
|
||||
}
|
||||
|
||||
.ots-main {
|
||||
margin-left: 250px; /* Must match sidebar width */
|
||||
}
|
||||
```
|
||||
|
||||
### Customize Fonts
|
||||
|
||||
Edit `css/override.css`:
|
||||
|
||||
```css
|
||||
/* Base font family */
|
||||
--font-family-base: 'Inter', -apple-system, BlinkMacSystemFont, sans-serif;
|
||||
|
||||
/* Monospace (for code) */
|
||||
--font-family-mono: 'Monaco', monospace;
|
||||
```
|
||||
|
||||
### Add Company Logo
|
||||
|
||||
1. Place logo at `img/logo.png` (recommended: 40x40px, PNG/SVG)
|
||||
2. Edit `views/authed-sidebar.twig`, line ~7:
|
||||
```twig
|
||||
<span class="brand-icon">🎯</span> <!-- Replace emoji with: -->
|
||||
<img src="{{ baseUrl }}/theme/custom/otssignange/img/logo.png" alt="{{ app_name }}" style="width: 28px; height: 28px;" />
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Browser Compatibility
|
||||
|
||||
- **Chrome/Edge:** ✅ Full support (latest 2 versions)
|
||||
- **Firefox:** ✅ Full support (latest 2 versions)
|
||||
- **Safari:** ✅ Full support (latest 2 versions)
|
||||
- **IE11:** ❌ Not supported (CSS Grid, CSS Variables not available)
|
||||
|
||||
**CSS Features Used:**
|
||||
- CSS Grid (layout)
|
||||
- CSS Flexbox (alignment)
|
||||
- CSS Variables (theming)
|
||||
- CSS Transitions (animations)
|
||||
- SVG inline (icons)
|
||||
|
||||
---
|
||||
|
||||
## Common Issues & Troubleshooting
|
||||
|
||||
### Issue: Sidebar not toggling on mobile
|
||||
**Solution:** Ensure `theme.js` is loaded. Check browser console for errors:
|
||||
```bash
|
||||
Press F12 → Console tab → Look for red errors
|
||||
```
|
||||
|
||||
### Issue: Dark theme not applying
|
||||
**Solution:** Clear Xibo cache and browser cache:
|
||||
1. **Xibo:** Settings → Maintenance → Purge Cache
|
||||
2. **Browser:** Ctrl+Shift+Delete (Windows) or Cmd+Shift+Delete (Mac)
|
||||
|
||||
### Issue: Images in media grid not showing
|
||||
**Solution:** Verify image URLs are accessible. Check:
|
||||
1. File permissions (644 for files, 755 for directories)
|
||||
2. Image format is supported (JPEG, PNG, GIF, WebP)
|
||||
|
||||
### Issue: Search bar styling broken
|
||||
**Solution:** Ensure `override.css` is fully loaded. Check:
|
||||
1. CSS file size: should be ~8-10 KB
|
||||
2. No CSS parse errors in DevTools (F12 → Console)
|
||||
|
||||
---
|
||||
|
||||
## Development & Debugging
|
||||
|
||||
### Enable Debug Mode
|
||||
|
||||
Edit `config.php`:
|
||||
|
||||
```php
|
||||
// Add at top of file
|
||||
define('DEBUG', true);
|
||||
```
|
||||
|
||||
### View Generated HTML
|
||||
|
||||
In browser, right-click → **Inspect Element** to see:
|
||||
- DOM structure
|
||||
- Applied CSS classes
|
||||
- CSS rules (with file/line)
|
||||
- SVG icons rendering
|
||||
|
||||
### Test Responsive Design
|
||||
|
||||
In browser DevTools (F12):
|
||||
1. Click **Toggle Device Toolbar** (or Ctrl+Shift+M)
|
||||
2. Select mobile device (iPhone 12, Pixel 5, etc.)
|
||||
3. Test sidebar toggle, search, menus
|
||||
|
||||
---
|
||||
|
||||
## Performance Metrics
|
||||
|
||||
- **CSS file size:** ~8 KB (minified)
|
||||
- **JS file size:** ~3 KB (minified)
|
||||
- **Load time (typical):** <500ms additional
|
||||
- **Lighthouse score:** 85+ (with proper images)
|
||||
|
||||
---
|
||||
|
||||
## Xibo CMS Integration Notes
|
||||
|
||||
### Theme Hooks (Twig Blocks)
|
||||
|
||||
The theme extends `base.twig` and overrides:
|
||||
|
||||
- `{% block head %}` - Link to custom CSS
|
||||
- `{% block htmlTag %}` - Dark mode attribute
|
||||
- `{% block body %}` - Custom shell structure
|
||||
- `{% block header %}` - Topbar
|
||||
- `{% block content %}` - Main content area
|
||||
- `{% block footer %}` - Footer
|
||||
- `{% block scripts %}` - Include theme.js
|
||||
|
||||
### Available Twig Variables
|
||||
|
||||
In views, you can access:
|
||||
|
||||
```twig
|
||||
{{ baseUrl }} # Base URL of Xibo CMS
|
||||
{{ app_name }} # Application name (from config.php)
|
||||
{{ user.username }} # Current user's login
|
||||
{{ currentDate }} # Current date/time
|
||||
{{ pageTitle }} # Page title (from view)
|
||||
{{ pageSubtitle }} # Optional page subtitle
|
||||
```
|
||||
|
||||
### CSS Class Conventions
|
||||
|
||||
Custom classes follow BEM naming:
|
||||
|
||||
```
|
||||
.ots-<component> # Root component
|
||||
.ots-<component>__item # Child element
|
||||
.ots-<component>--active # Modifier
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
### Planned Features
|
||||
- [ ] Light mode toggle (currently dark only)
|
||||
- [ ] Custom color picker in admin
|
||||
- [ ] Theme variants (compact, expanded sidebar)
|
||||
- [ ] Export/import settings
|
||||
- [ ] RTL (Right-to-Left) support
|
||||
|
||||
### Community Contribution Ideas
|
||||
- Additional color schemes
|
||||
- Accessibility improvements (AAA contrast)
|
||||
- More page overrides (Settings, Users, Schedules)
|
||||
- Keyboard navigation enhancements
|
||||
- Dashboard widget system
|
||||
|
||||
---
|
||||
|
||||
## Support & License
|
||||
|
||||
**License:** AGPL-3.0 (inherited from Xibo CMS)
|
||||
|
||||
**Legal Notice:**
|
||||
This theme is provided as-is for use with Xibo Digital Signage CMS. It maintains compatibility with Xibo's AGPL license. Any modifications must be shared with the community under the same license.
|
||||
|
||||
**Support Channels:**
|
||||
- Xibo Community Forum: https://community.xibo.org.uk/
|
||||
- GitHub Issues: https://github.com/xibosignage/xibo-cms/issues
|
||||
|
||||
---
|
||||
|
||||
## Credits
|
||||
|
||||
**Theme Created For:** OTS Signs
|
||||
**Based On:** Xibo CMS v4.0+ default theme
|
||||
**Design System:** Modern dark theme with blue accent
|
||||
**Created:** February 2026
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
### v1.0.0 (Initial Release)
|
||||
- Complete redesign of dashboard, displays, media views
|
||||
- Dark theme with blue accent color
|
||||
- Responsive sidebar & topbar
|
||||
- Modern component system
|
||||
- SVG icon integration
|
||||
- Keyboard & mobile accessibility
|
||||
- ~1000 lines of new CSS
|
||||
- Interactive JavaScript components
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### CSS Variables
|
||||
```css
|
||||
--color-primary: #3b82f6 /* Main brand color */
|
||||
--color-background: #0f172a /* Page background */
|
||||
--color-surface: #1e293b /* Card/panel background */
|
||||
--color-text-primary: #f1f5f9 /* Main text */
|
||||
--color-border: #475569 /* Dividers */
|
||||
```
|
||||
|
||||
### Breakpoints
|
||||
```css
|
||||
Mobile: max-width: 640px
|
||||
Tablet: 641px - 768px
|
||||
Desktop: 769px+
|
||||
```
|
||||
|
||||
### Key Classes
|
||||
```
|
||||
.ots-shell /* Main layout wrapper */
|
||||
.ots-sidebar /* Left navigation */
|
||||
.ots-topbar /* Top header bar */
|
||||
.ots-content /* Main content area */
|
||||
.kpi-section /* Dashboard KPI grid */
|
||||
.panel /* Card component */
|
||||
.btn /* Button */
|
||||
.badge /* Status badge */
|
||||
.table /* Data table */
|
||||
.media-grid /* Image grid */
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**For questions or issues, refer to the Xibo Community Forum or review the theme files directly.**
|
||||
@@ -1,176 +0,0 @@
|
||||
/**
|
||||
* OTS Signage Modern Theme - Client-Side Utilities
|
||||
* Sidebar toggle, dropdown menus, and UI interactions
|
||||
*/
|
||||
|
||||
(function() {
|
||||
'use strict';
|
||||
|
||||
const STORAGE_KEYS = {
|
||||
sidebarCollapsed: 'otsTheme:sidebarCollapsed'
|
||||
};
|
||||
|
||||
/**
|
||||
* Initialize sidebar toggle functionality
|
||||
*/
|
||||
function initSidebarToggle() {
|
||||
const toggleBtn = document.querySelector('[data-action="toggle-sidebar"]');
|
||||
const sidebar = document.querySelector('.ots-sidebar');
|
||||
|
||||
if (!toggleBtn || !sidebar) return;
|
||||
|
||||
toggleBtn.addEventListener('click', function(e) {
|
||||
e.preventDefault();
|
||||
sidebar.classList.toggle('active');
|
||||
});
|
||||
|
||||
// Close sidebar when clicking outside on mobile
|
||||
document.addEventListener('click', function(e) {
|
||||
if (window.innerWidth <= 768) {
|
||||
const isClickInsideSidebar = sidebar.contains(e.target);
|
||||
const isClickOnToggle = toggleBtn.contains(e.target);
|
||||
|
||||
if (!isClickInsideSidebar && !isClickOnToggle && sidebar.classList.contains('active')) {
|
||||
sidebar.classList.remove('active');
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize dropdown menus
|
||||
*/
|
||||
function initDropdowns() {
|
||||
const dropdowns = document.querySelectorAll('.dropdown');
|
||||
|
||||
dropdowns.forEach(dropdown => {
|
||||
const button = dropdown.querySelector('.dropdown-menu');
|
||||
|
||||
if (!button) return;
|
||||
|
||||
const menu = dropdown.querySelector('.dropdown-menu');
|
||||
|
||||
// Toggle menu on button click
|
||||
dropdown.addEventListener('click', function(e) {
|
||||
if (e.target.closest('.user-btn') || e.target.closest('[aria-label="User menu"]')) {
|
||||
e.preventDefault();
|
||||
dropdown.classList.toggle('active');
|
||||
}
|
||||
});
|
||||
|
||||
// Close menu when clicking outside
|
||||
document.addEventListener('click', function(e) {
|
||||
if (!dropdown.contains(e.target)) {
|
||||
dropdown.classList.remove('active');
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize search functionality
|
||||
*/
|
||||
function initSearch() {
|
||||
const searchForm = document.querySelector('.topbar-search');
|
||||
if (!searchForm) return;
|
||||
|
||||
const input = searchForm.querySelector('.search-input');
|
||||
if (input) {
|
||||
input.addEventListener('focus', function() {
|
||||
searchForm.style.borderColor = 'var(--color-primary)';
|
||||
});
|
||||
input.addEventListener('blur', function() {
|
||||
searchForm.style.borderColor = 'var(--color-border)';
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize page specific interactions
|
||||
*/
|
||||
function initPageInteractions() {
|
||||
// Displays page - folder selection
|
||||
const folderItems = document.querySelectorAll('.folder-item');
|
||||
folderItems.forEach(item => {
|
||||
item.addEventListener('click', function() {
|
||||
folderItems.forEach(f => f.classList.remove('active'));
|
||||
this.classList.add('active');
|
||||
});
|
||||
});
|
||||
|
||||
// Media page - item selection
|
||||
const mediaItems = document.querySelectorAll('.media-item');
|
||||
mediaItems.forEach(item => {
|
||||
item.addEventListener('click', function() {
|
||||
this.style.opacity = '0.7';
|
||||
setTimeout(() => this.style.opacity = '1', 200);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Make sidebar responsive
|
||||
*/
|
||||
function makeResponsive() {
|
||||
const sidebar = document.querySelector('.ots-sidebar');
|
||||
const main = document.querySelector('.ots-main');
|
||||
|
||||
if (!sidebar) return;
|
||||
|
||||
// Add toggle button for mobile
|
||||
if (window.innerWidth <= 768) {
|
||||
sidebar.classList.add('mobile');
|
||||
}
|
||||
|
||||
window.addEventListener('resize', function() {
|
||||
if (window.innerWidth > 768) {
|
||||
sidebar.classList.remove('mobile', 'active');
|
||||
} else {
|
||||
sidebar.classList.add('mobile');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize all features when DOM is ready
|
||||
*/
|
||||
function init() {
|
||||
initSidebarToggle();
|
||||
initDropdowns();
|
||||
initSearch();
|
||||
initPageInteractions();
|
||||
makeResponsive();
|
||||
}
|
||||
|
||||
// Wait for DOM to be ready
|
||||
if (document.readyState === 'loading') {
|
||||
document.addEventListener('DOMContentLoaded', init);
|
||||
} else {
|
||||
init();
|
||||
}
|
||||
})();
|
||||
|
||||
themeBtn.addEventListener('click', function() {
|
||||
const currentTheme = html.getAttribute('data-theme') || 'light';
|
||||
const newTheme = currentTheme === 'dark' ? 'light' : 'dark';
|
||||
|
||||
html.setAttribute('data-theme', newTheme);
|
||||
localStorage.setItem(STORAGE_KEYS.themeMode, newTheme);
|
||||
themeBtn.setAttribute('aria-pressed', newTheme === 'dark');
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize page on DOM ready
|
||||
*/
|
||||
function init() {
|
||||
initSidebarToggle();
|
||||
initThemeToggle();
|
||||
}
|
||||
|
||||
if (document.readyState === 'loading') {
|
||||
document.addEventListener('DOMContentLoaded', init);
|
||||
} else {
|
||||
init();
|
||||
}
|
||||
})();
|
||||
@@ -1,116 +0,0 @@
|
||||
{#
|
||||
OTS Signage Modern Theme - Sidebar Override
|
||||
Modern left navigation sidebar with collapsible state and icons
|
||||
#}
|
||||
<nav class="ots-sidebar" aria-label="Main navigation">
|
||||
<div class="sidebar-header">
|
||||
<a href="{{ baseUrl }}/" class="brand-link">
|
||||
<span class="brand-icon">🎯</span>
|
||||
<span class="brand-text">OTS Signs</span>
|
||||
</a>
|
||||
<button class="sidebar-close-btn" aria-label="Close sidebar">
|
||||
<svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<line x1="18" y1="6" x2="6" y2="18"/><line x1="6" y1="6" x2="18" y2="18"/>
|
||||
</svg>
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-content">
|
||||
<ul class="sidebar-nav">
|
||||
<li>
|
||||
<a href="{{ baseUrl }}" class="nav-item {% if pageTitle == 'Dashboard' %}active{% endif %}">
|
||||
<svg class="nav-icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<rect x="3" y="3" width="7" height="7"/><rect x="14" y="3" width="7" height="7"/><rect x="14" y="14" width="7" height="7"/><rect x="3" y="14" width="7" height="7"/>
|
||||
</svg>
|
||||
<span class="nav-text">Dashboard</span>
|
||||
</a>
|
||||
</li>
|
||||
|
||||
<li class="nav-section-divider">
|
||||
<span class="nav-label">Content</span>
|
||||
</li>
|
||||
<li><a href="{{ baseUrl }}/library" class="nav-item">
|
||||
<svg class="nav-icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M22 19a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h5l2 3h9a2 2 0 0 1 2 2z"/>
|
||||
</svg>
|
||||
<span class="nav-text">Media Library</span>
|
||||
</a></li>
|
||||
<li><a href="{{ baseUrl }}/layout" class="nav-item">
|
||||
<svg class="nav-icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<rect x="3" y="3" width="18" height="18" rx="2" ry="2"/><line x1="9" y1="3" x2="9" y2="21"/><line x1="15" y1="3" x2="15" y2="21"/>
|
||||
</svg>
|
||||
<span class="nav-text">Layouts</span>
|
||||
</a></li>
|
||||
<li><a href="{{ baseUrl }}/playlist" class="nav-item">
|
||||
<svg class="nav-icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<polygon points="23 7 16 12 23 17 23 7"/><rect x="1" y="5" width="15" height="14" rx="2" ry="2"/>
|
||||
</svg>
|
||||
<span class="nav-text">Playlists</span>
|
||||
</a></li>
|
||||
|
||||
<li class="nav-section-divider">
|
||||
<span class="nav-label">Displays</span>
|
||||
</li>
|
||||
<li><a href="{{ baseUrl }}/display" class="nav-item">
|
||||
<svg class="nav-icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<rect x="2" y="3" width="20" height="14" rx="2" ry="2"/><path d="M12 17v4"/><path d="M8 21h8"/>
|
||||
</svg>
|
||||
<span class="nav-text">Displays</span>
|
||||
</a></li>
|
||||
<li><a href="{{ baseUrl }}/display-group" class="nav-item">
|
||||
<svg class="nav-icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<rect x="2" y="2" width="8" height="8" rx="1" ry="1"/><rect x="14" y="2" width="8" height="8" rx="1" ry="1"/><rect x="2" y="14" width="8" height="8" rx="1" ry="1"/><rect x="14" y="14" width="8" height="8" rx="1" ry="1"/>
|
||||
</svg>
|
||||
<span class="nav-text">Display Groups</span>
|
||||
</a></li>
|
||||
|
||||
<li class="nav-section-divider">
|
||||
<span class="nav-label">Scheduling</span>
|
||||
</li>
|
||||
<li><a href="{{ baseUrl }}/schedule" class="nav-item">
|
||||
<svg class="nav-icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<rect x="3" y="4" width="18" height="18" rx="2" ry="2"/><path d="M16 2v4"/><path d="M8 2v4"/><line x1="3" y1="10" x2="21" y2="10"/>
|
||||
</svg>
|
||||
<span class="nav-text">Schedules</span>
|
||||
</a></li>
|
||||
<li><a href="{{ baseUrl }}/dayparting" class="nav-item">
|
||||
<svg class="nav-icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<circle cx="12" cy="12" r="9"/><polyline points="12 6 12 12 16 14"/>
|
||||
</svg>
|
||||
<span class="nav-text">Day Parting</span>
|
||||
</a></li>
|
||||
|
||||
<li class="nav-section-divider">
|
||||
<span class="nav-label">Administration</span>
|
||||
</li>
|
||||
<li><a href="{{ baseUrl }}/user" class="nav-item">
|
||||
<svg class="nav-icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M20 21v-2a4 4 0 0 0-4-4H8a4 4 0 0 0-4 4v2"/><circle cx="12" cy="7" r="4"/>
|
||||
</svg>
|
||||
<span class="nav-text">Users</span>
|
||||
</a></li>
|
||||
<li><a href="{{ baseUrl }}/user-group" class="nav-item">
|
||||
<svg class="nav-icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M17 21v-2a4 4 0 0 0-4-4H5a4 4 0 0 0-4 4v2"/><circle cx="9" cy="7" r="4"/><path d="M23 21v-2a4 4 0 0 0-3-3.87"/><path d="M16 3.13a4 4 0 0 1 0 7.75"/>
|
||||
</svg>
|
||||
<span class="nav-text">User Groups</span>
|
||||
</a></li>
|
||||
<li><a href="{{ baseUrl }}/settings" class="nav-item">
|
||||
<svg class="nav-icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<circle cx="12" cy="12" r="3"/><path d="M12 1v6m0 6v6M4.22 4.22l4.24 4.24m2.12 2.12l4.24 4.24M1 12h6m6 0h6m-16.78 7.78l4.24-4.24m2.12-2.12l4.24-4.24"/>
|
||||
</svg>
|
||||
<span class="nav-text">Settings</span>
|
||||
</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="sidebar-footer">
|
||||
<div class="sidebar-user">
|
||||
<div class="user-avatar user-avatar-lg">{{ user.username|first|upper }}</div>
|
||||
<div class="user-details">
|
||||
<div class="user-name">{{ user.username }}</div>
|
||||
<div class="user-role text-xs">Administrator</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
@@ -1,83 +0,0 @@
|
||||
{#
|
||||
OTS Signage Modern Theme - Authenticated Shell Override
|
||||
Replaces the header and shell structure with a modern topbar + sidebar layout
|
||||
#}
|
||||
{% extends "base.twig" %}
|
||||
|
||||
{% block head %}
|
||||
{{ parent() }}
|
||||
<link rel="stylesheet" href="{{ baseUrl }}/theme/custom/otssignange/css/override.css" />
|
||||
<link rel="stylesheet" href="{{ baseUrl }}/theme/custom/otssignange/css/client.css" />
|
||||
{% endblock %}
|
||||
|
||||
{% block htmlTag %}
|
||||
<html lang="en" data-ots-theme="v1" data-mode="dark">
|
||||
{% endblock %}
|
||||
|
||||
{% block body %}
|
||||
<body class="ots-theme ots-dark-mode">
|
||||
<div class="ots-shell">
|
||||
{% include "authed-sidebar.twig" %}
|
||||
|
||||
<div class="ots-main">
|
||||
{% block header %}
|
||||
<header class="ots-topbar">
|
||||
<div class="topbar-left">
|
||||
<button class="btn-ghost topbar-toggle" data-action="toggle-sidebar" aria-label="Toggle sidebar" title="Toggle sidebar">
|
||||
<svg class="icon" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<line x1="3" y1="6" x2="21" y2="6"/><line x1="3" y1="12" x2="21" y2="12"/><line x1="3" y1="18" x2="21" y2="18"/>
|
||||
</svg>
|
||||
</button>
|
||||
<div class="topbar-title">
|
||||
<h1 class="page-title">{{ pageTitle|default('Dashboard') }}</h1>
|
||||
{% if pageSubtitle is defined %}<p class="page-subtitle">{{ pageSubtitle }}</p>{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="topbar-right">
|
||||
<form action="{{ baseUrl }}/search" class="topbar-search" method="get" role="search">
|
||||
<svg class="search-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<circle cx="11" cy="11" r="8"/><path d="m21 21-4.35-4.35"/>
|
||||
</svg>
|
||||
<input type="text" name="q" placeholder="Search…" aria-label="Search" class="search-input" />
|
||||
</form>
|
||||
<div class="topbar-actions">
|
||||
<button class="topbar-btn" aria-label="Notifications" title="Notifications">
|
||||
<svg class="icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M18 8A6 6 0 0 0 6 8c0 7-3 9-3 9h18s-3-2-3-9"/><path d="M13.73 21a2 2 0 0 1-3.46 0"/>
|
||||
</svg>
|
||||
</button>
|
||||
<div class="dropdown user-menu">
|
||||
<button class="topbar-btn user-btn" aria-label="User menu" aria-expanded="false">
|
||||
<span class="avatar avatar-sm">{{ user.username|first|upper }}</span>
|
||||
</button>
|
||||
<ul class="dropdown-menu dropdown-right" role="menu">
|
||||
<li><a href="{{ baseUrl }}/profile" role="menuitem">Profile</a></li>
|
||||
<li><a href="{{ baseUrl }}/logout" role="menuitem">Sign out</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
{% endblock %}
|
||||
|
||||
<main class="ots-content">
|
||||
{% block content %}
|
||||
<!-- Content inserted here by page templates -->
|
||||
{% endblock %}
|
||||
</main>
|
||||
|
||||
{% block footer %}
|
||||
<footer class="ots-footer">
|
||||
<p class="text-muted text-xs">© {{ currentDate|date('Y') }} {{ app_name }}. Powered by <a href="https://xibosignage.com">Xibo</a>.</p>
|
||||
</footer>
|
||||
{% endblock %}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{% block scripts %}
|
||||
{{ parent() }}
|
||||
<script src="{{ baseUrl }}/theme/custom/otssignange/js/theme.js"></script>
|
||||
{% endblock %}
|
||||
</body>
|
||||
{% endblock %}
|
||||
@@ -1,131 +0,0 @@
|
||||
{#
|
||||
OTS Signage Modern Theme - Dashboard Page Override
|
||||
Modern dashboard with KPI cards, status panels, and quick actions
|
||||
#}
|
||||
{% extends "authed.twig" %}
|
||||
|
||||
{% block pageTitle %}Dashboard{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="ots-theme dashboard-page">
|
||||
{# KPI Cards Row #}
|
||||
<section class="kpi-section">
|
||||
<div class="kpi-card">
|
||||
<div class="kpi-header">
|
||||
<h3 class="kpi-label">Displays</h3>
|
||||
<span class="kpi-icon-box">
|
||||
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<rect x="2" y="3" width="20" height="14" rx="2" ry="2"/><path d="M12 17v4"/><path d="M8 21h8"/>
|
||||
</svg>
|
||||
</span>
|
||||
</div>
|
||||
<div class="kpi-body">
|
||||
<div class="kpi-number">1</div>
|
||||
<div class="kpi-meta">100% Displays Online</div>
|
||||
</div>
|
||||
<div class="kpi-footer">
|
||||
<span class="badge badge-success">1</span>
|
||||
<span class="text-xs text-muted">Online</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="kpi-card">
|
||||
<div class="kpi-header">
|
||||
<h3 class="kpi-label">Schedules</h3>
|
||||
<span class="kpi-icon-box">
|
||||
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<rect x="3" y="4" width="18" height="18" rx="2" ry="2"/><path d="M16 2v4"/><path d="M8 2v4"/><line x1="3" y1="10" x2="21" y2="10"/>
|
||||
</svg>
|
||||
</span>
|
||||
</div>
|
||||
<div class="kpi-body">
|
||||
<div class="kpi-number">0</div>
|
||||
<div class="kpi-meta">Scheduled events</div>
|
||||
</div>
|
||||
<div class="kpi-footer">
|
||||
<span class="badge badge-secondary">0</span>
|
||||
<span class="text-xs text-muted">Upcoming</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="kpi-card">
|
||||
<div class="kpi-header">
|
||||
<h3 class="kpi-label">Users</h3>
|
||||
<span class="kpi-icon-box">
|
||||
<svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M20 21v-2a4 4 0 0 0-4-4H8a4 4 0 0 0-4 4v2"/><circle cx="12" cy="7" r="4"/>
|
||||
</svg>
|
||||
</span>
|
||||
</div>
|
||||
<div class="kpi-body">
|
||||
<div class="kpi-number">2</div>
|
||||
<div class="kpi-meta">OTS Signs users</div>
|
||||
</div>
|
||||
<div class="kpi-footer">
|
||||
<span class="badge badge-info">2</span>
|
||||
<span class="text-xs text-muted">Active</span>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
{# Main Panels Row #}
|
||||
<section class="dashboard-panels">
|
||||
<article class="panel panel-full">
|
||||
<div class="panel-header">
|
||||
<h3>Display Status</h3>
|
||||
<a href="{{ baseUrl }}/display" class="link-secondary">View all →</a>
|
||||
</div>
|
||||
<div class="panel-body">
|
||||
<div class="empty-state-compact">
|
||||
<p class="text-muted">You have 1 display configured. Last check-in: just now</p>
|
||||
<a href="{{ baseUrl }}/display" class="btn btn-outline btn-sm">Manage Displays</a>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
|
||||
<article class="panel panel-full">
|
||||
<div class="panel-header">
|
||||
<h3>Upcoming Schedules</h3>
|
||||
<a href="{{ baseUrl }}/schedule" class="link-secondary">View all →</a>
|
||||
</div>
|
||||
<div class="panel-body">
|
||||
<div class="empty-state-compact">
|
||||
<p class="text-muted">No schedules found. Create a schedule to get started.</p>
|
||||
<a href="{{ baseUrl }}/schedule/add" class="btn btn-outline btn-sm">Create Schedule</a>
|
||||
</div>
|
||||
</div>
|
||||
</article>
|
||||
</section>
|
||||
|
||||
{# Quick Actions Section #}
|
||||
<section class="quick-actions-grid">
|
||||
<h3 class="section-title">Quick Actions</h3>
|
||||
<div class="action-cards">
|
||||
<a href="{{ baseUrl }}/schedule/add" class="action-card">
|
||||
<div class="action-icon">
|
||||
<svg width="32" height="32" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<rect x="3" y="4" width="18" height="18" rx="2" ry="2"/><path d="M16 2v4"/><path d="M8 2v4"/><line x1="3" y1="10" x2="21" y2="10"/>
|
||||
</svg>
|
||||
</div>
|
||||
<span class="action-label">Create Schedule</span>
|
||||
</a>
|
||||
<a href="{{ baseUrl }}/display" class="action-card">
|
||||
<div class="action-icon">
|
||||
<svg width="32" height="32" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<rect x="2" y="3" width="20" height="14" rx="2" ry="2"/><path d="M12 17v4"/><path d="M8 21h8"/>
|
||||
</svg>
|
||||
</div>
|
||||
<span class="action-label">Manage Displays</span>
|
||||
</a>
|
||||
<a href="{{ baseUrl }}/user/add" class="action-card">
|
||||
<div class="action-icon">
|
||||
<svg width="32" height="32" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M20 21v-2a4 4 0 0 0-4-4H8a4 4 0 0 0-4 4v2"/><circle cx="12" cy="7" r="4"/>
|
||||
</svg>
|
||||
</div>
|
||||
<span class="action-label">Add User</span>
|
||||
</a>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
{% endblock %}
|
||||
@@ -1,124 +0,0 @@
|
||||
{#
|
||||
OTS Signage Modern Theme - Displays Page Override
|
||||
Two-column layout with folder panel on left, modern display table
|
||||
#}
|
||||
{% extends "authed.twig" %}
|
||||
|
||||
{% block pageTitle %}Displays{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="ots-theme two-column-layout">
|
||||
<aside class="left-panel displays-sidebar">
|
||||
<div class="panel-header">
|
||||
<h3>Folders</h3>
|
||||
<button class="btn-icon-sm" aria-label="Expand/collapse">
|
||||
<svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<polyline points="12 3 20 9 12 15 4 9 12 3"/><polyline points="4 15 12 21 20 15"/>
|
||||
</svg>
|
||||
</button>
|
||||
</div>
|
||||
<div class="folder-tree">
|
||||
<div class="folder-item active">
|
||||
<svg class="folder-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M22 19a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h5l2 3h9a2 2 0 0 1 2 2z"/>
|
||||
</svg>
|
||||
<span class="folder-name">All Items</span>
|
||||
</div>
|
||||
<div class="folder-item">
|
||||
<svg class="folder-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M22 19a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h5l2 3h9a2 2 0 0 1 2 2z"/>
|
||||
</svg>
|
||||
<span class="folder-name">Root Folder</span>
|
||||
</div>
|
||||
<div class="folder-item">
|
||||
<svg class="folder-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M22 19a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h5l2 3h9a2 2 0 0 1 2 2z"/>
|
||||
</svg>
|
||||
<span class="folder-name">TEMPLATE_DemoHolder</span>
|
||||
</div>
|
||||
<div class="folder-item" style="margin-left: 16px;">
|
||||
<svg class="folder-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M22 19a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h5l2 3h9a2 2 0 0 1 2 2z"/>
|
||||
</svg>
|
||||
<span class="folder-name">Hospitality</span>
|
||||
</div>
|
||||
<div class="folder-item" style="margin-left: 16px;">
|
||||
<svg class="folder-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M22 19a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h5l2 3h9a2 2 0 0 1 2 2z"/>
|
||||
</svg>
|
||||
<span class="folder-name">Retail</span>
|
||||
</div>
|
||||
<div class="folder-item">
|
||||
<svg class="folder-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M22 19a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h5l2 3h9a2 2 0 0 1 2 2z"/>
|
||||
</svg>
|
||||
<span class="folder-name">OTS Signs Internal</span>
|
||||
</div>
|
||||
</div>
|
||||
</aside>
|
||||
|
||||
<main class="content-panel">
|
||||
<div class="page-header">
|
||||
<h1>Displays</h1>
|
||||
<p class="text-muted">Manage and monitor your digital signage displays</p>
|
||||
</div>
|
||||
|
||||
<div class="content-toolbar">
|
||||
<div class="search-wrapper">
|
||||
<svg class="search-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<circle cx="11" cy="11" r="8"/><path d="m21 21-4.35-4.35"/>
|
||||
</svg>
|
||||
<input type="search" placeholder="Search displays…" class="form-control search-field" />
|
||||
</div>
|
||||
<div class="toolbar-actions">
|
||||
<button class="btn btn-outline btn-sm">Columns</button>
|
||||
<a href="{{ baseUrl }}/display/add" class="btn btn-primary btn-sm">Add Display</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="stat-row">
|
||||
<div class="stat-box">
|
||||
<div class="stat-label">Total</div>
|
||||
<div class="stat-value">1</div>
|
||||
</div>
|
||||
<div class="stat-box">
|
||||
<div class="stat-label">Online</div>
|
||||
<div class="stat-value text-success">1</div>
|
||||
</div>
|
||||
<div class="stat-box">
|
||||
<div class="stat-label">Offline</div>
|
||||
<div class="stat-value text-danger">0</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="table-wrapper">
|
||||
<table class="table table-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width: 25%;">Display</th>
|
||||
<th style="width: 15%;">Status</th>
|
||||
<th style="width: 20%;">Folder</th>
|
||||
<th style="width: 15%;">Group</th>
|
||||
<th style="width: 15%;">Last Check-in</th>
|
||||
<th style="width: 10%;">Actions</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><strong>Test1</strong></td>
|
||||
<td><span class="badge badge-success">Online</span></td>
|
||||
<td>TEMPLATE_DemoHolder</td>
|
||||
<td>Test Screens</td>
|
||||
<td><span class="text-xs">just now</span></td>
|
||||
<td>
|
||||
<button class="btn-icon-sm" aria-label="Actions">
|
||||
<svg width="18" height="18" viewBox="0 0 24 24" fill="currentColor"><circle cx="12" cy="5" r="2"/><circle cx="12" cy="12" r="2"/><circle cx="12" cy="19" r="2"/></svg>
|
||||
</button>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
{% endblock %}
|
||||
@@ -1,129 +0,0 @@
|
||||
{#
|
||||
OTS Signage Modern Theme - Media Library Page Override
|
||||
Two-column layout with folder panel on left, media grid on right
|
||||
#}
|
||||
{% extends "authed.twig" %}
|
||||
|
||||
{% block pageTitle %}Media Library{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="ots-theme two-column-layout">
|
||||
<aside class="left-panel media-sidebar">
|
||||
<div class="panel-header">
|
||||
<h3>Folders</h3>
|
||||
<button class="btn-icon-sm" aria-label="New folder">
|
||||
<svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<line x1="12" y1="5" x2="12" y2="19"/><line x1="5" y1="12" x2="19" y2="12"/>
|
||||
</svg>
|
||||
</button>
|
||||
</div>
|
||||
<div class="folder-tree">
|
||||
<div class="folder-item active">
|
||||
<svg class="folder-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M22 19a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h5l2 3h9a2 2 0 0 1 2 2z"/>
|
||||
</svg>
|
||||
<span class="folder-name">All Files</span>
|
||||
</div>
|
||||
<div class="folder-item">
|
||||
<svg class="folder-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<path d="M22 19a2 2 0 0 1-2 2H4a2 2 0 0 1-2-2V5a2 2 0 0 1 2-2h5l2 3h9a2 2 0 0 1 2 2z"/>
|
||||
</svg>
|
||||
<span class="folder-name">Root Folder</span>
|
||||
</div>
|
||||
<div class="folder-item">
|
||||
<svg class="folder-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<rect x="3" y="3" width="18" height="18" rx="2" ry="2"/><circle cx="8.5" cy="8.5" r="1.5"/><polyline points="21 15 16 10 5 21"/>
|
||||
</svg>
|
||||
<span class="folder-name">Images</span>
|
||||
</div>
|
||||
<div class="folder-item">
|
||||
<svg class="folder-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<polygon points="23 7 16 12 23 17 23 7"/><rect x="1" y="5" width="15" height="14" rx="2" ry="2"/>
|
||||
</svg>
|
||||
<span class="folder-name">Videos</span>
|
||||
</div>
|
||||
</div>
|
||||
</aside>
|
||||
|
||||
<main class="content-panel">
|
||||
<div class="page-header">
|
||||
<h1>Media Library</h1>
|
||||
<p class="text-muted">Upload and manage your images and videos for digital signage</p>
|
||||
</div>
|
||||
|
||||
<div class="content-toolbar">
|
||||
<div class="search-wrapper">
|
||||
<svg class="search-icon" width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2">
|
||||
<circle cx="11" cy="11" r="8"/><path d="m21 21-4.35-4.35"/>
|
||||
</svg>
|
||||
<input type="search" placeholder="Search media…" class="form-control search-field" />
|
||||
</div>
|
||||
<div class="toolbar-actions">
|
||||
<button class="btn btn-outline btn-sm">All Media</button>
|
||||
<a href="{{ baseUrl }}/library/add" class="btn btn-primary btn-sm">Upload Media</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="stat-row">
|
||||
<div class="stat-box">
|
||||
<div class="stat-label">Total Files</div>
|
||||
<div class="stat-value">4</div>
|
||||
</div>
|
||||
<div class="stat-box">
|
||||
<div class="stat-label">Storage Used</div>
|
||||
<div class="stat-value">12.3 MB</div>
|
||||
</div>
|
||||
<div class="stat-box">
|
||||
<div class="stat-label">Storage Limit</div>
|
||||
<div class="stat-value">5 GB</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="media-grid">
|
||||
<div class="media-item">
|
||||
<div class="media-thumbnail">
|
||||
<img src="https://images.unsplash.com/photo-1444080748397-f442aa95c3e5?w=400&h=300&fit=crop" alt="Galaxy space" />
|
||||
<span class="media-type-badge">Image</span>
|
||||
</div>
|
||||
<div class="media-info">
|
||||
<p class="media-name">2000x1158</p>
|
||||
<p class="media-size text-xs text-muted">3.3 MB • 1920x1112</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="media-item">
|
||||
<div class="media-thumbnail">
|
||||
<img src="https://images.unsplash.com/photo-1478098711619-69891b0ec21a?w=400&h=300&fit=crop" alt="Cat portrait" />
|
||||
<span class="media-type-badge">Image</span>
|
||||
</div>
|
||||
<div class="media-info">
|
||||
<p class="media-name">Images.jpg</p>
|
||||
<p class="media-size text-xs text-muted">5.2 KB • 194x260</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="media-item">
|
||||
<div class="media-thumbnail">
|
||||
<img src="https://images.unsplash.com/photo-1577720643272-265b434c829c?w=400&h=300&fit=crop" alt="OTS Logo" />
|
||||
<span class="media-type-badge">Image</span>
|
||||
</div>
|
||||
<div class="media-info">
|
||||
<p class="media-name">OTS Logo</p>
|
||||
<p class="media-size text-xs text-muted">2.9 KB • 360x350</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="media-item">
|
||||
<div class="media-thumbnail">
|
||||
<img src="https://images.unsplash.com/photo-1590080876-8b7f22b5d5fa?w=400&h=300&fit=crop" alt="Sunrise Hotel" />
|
||||
<span class="media-type-badge">Image</span>
|
||||
</div>
|
||||
<div class="media-info">
|
||||
<p class="media-name">suncrest hotel l...</p>
|
||||
<p class="media-size text-xs text-muted">4.1 KB • 5824x3401</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
{% endblock %}
|
||||
28
manual/en/check_fr.py
Normal file
@@ -0,0 +1,28 @@
|
||||
import os
|
||||
import re
|
||||
|
||||
os.chdir('/Users/matt/dev/OTSSignsTheme/manual/en')
|
||||
|
||||
files = [
|
||||
'layouts_editor.html', 'layouts_editor_design_changes.html',
|
||||
'layouts_editor_editing_tools.html', 'layouts_editor_global_elements.html',
|
||||
'layouts_editor_library_search.html', 'layouts_editor_using_templates.html',
|
||||
'layouts_interactive_actions.html', 'scheduling_repeats.html',
|
||||
'scheduling_layout_list.html', 'scheduling_priority_display_order.html',
|
||||
'users_administration.html', 'users_groups.html',
|
||||
'configure_folders.html', 'configure_tags.html',
|
||||
'getting_started_showing_a_playlist.html', 'getting_started_showing_a_playlist_v4.html',
|
||||
'getting_started_showing_a_video.html', 'getting_started_showing_a_video_v4.html',
|
||||
'getting_started_showing_an_image.html', 'getting_started_showing_an_image_v4.html',
|
||||
]
|
||||
|
||||
for fn in files:
|
||||
with open(fn) as f:
|
||||
content = f.read()
|
||||
idx = content.find('further_reading')
|
||||
if idx == -1:
|
||||
continue
|
||||
fr_block = content[idx:idx+600]
|
||||
print(f'=== {fn} ===')
|
||||
print(fr_block[:400])
|
||||
print()
|
||||
274
manual/en/configure_cms_settings.html
Normal file
@@ -0,0 +1,274 @@
|
||||
<!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="configure">
|
||||
<!-- 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><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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<p class="active"><a href="configure_cms_settings.html">Configure CMS Settings</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="configure_tags.html">Tags</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="configure_folders.html">Folders</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="configure_transitions.html">Transitions</a></p>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<li><a href="troubleshooting.html" data-toc-name="troubleshooting">Troubleshooting</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-md-9" role="main">
|
||||
<h1 id="cms_administrator_settings">CMS Administrator Settings <a href="#cms_administrator_settings" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Like any complex application, the OTS Signs Command Center CMS comes with a number of configurable options. These are located from the <strong>Settings</strong> page under the <strong>Administration</strong> section of the main CMS menu.</p>
|
||||
<p>Settings are split into related category tabs:</p>
|
||||
<p><img src="img/v4_tour_cms_settings_admin.png" alt="CMS Settings" /></p>
|
||||
<h2 id="configuration">Configuration <a href="#configuration" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>From this tab view the <strong>CMS Secret Key</strong> which is used to authenticate Players with the CMS and apply a <strong>Theme</strong> to pages (if applicable) as well as setting the default positioning for the <a href="tour_cms_navigation.html">Navigation Menu</a>.</p>
|
||||
<h2 id="defaults">Defaults <a href="#defaults" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Use this tab to apply defaults to all <a href="media_library.html">Media</a> files and set default <a href="configure_transitions.html">Transitions</a>.</p>
|
||||
<p>You can also set Layouts to <strong>automatically Publish</strong> 30 minutes after the last recorded edit by enabling the checkbox for this setting.</p>
|
||||
<h3>Resizing Images</h3>
|
||||
<p>Default thresholds and limits can be specified which are then considered in the event an image should be resized. This could be when uploading an image or an image being downloaded by a Widget - NASA RSS in a Ticker Widget for example.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<h4>Resize Threshold</h4>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Set a maximum threshold (based on the longest side) that should be considered for resizing an image.</p>
|
||||
<blockquote class="tip"><p>If you set a Resize Threshold of 1920 and you upload/download an image which is 800, this image would not need resizing. If you uploaded/downloaded an image which was 2400, this would then be resized to 1920.</p>
|
||||
</blockquote>
|
||||
<ul>
|
||||
<li>
|
||||
<h4>Resize Limit</h4>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Set a limit (based on the longest side) for uploaded/downloaded images. Images that exceed this limit will not be processed and should be replaced with another image that is within the limit.</p>
|
||||
<p>This setting will determine whether the image file is too large to be processed.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<h4>DataSet maximum number of Rows</h4>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Set the maximum permitted number of rows a User can create in a DataSet.</p>
|
||||
<h2 id="<strong>displays</strong>"><strong>Displays</strong> <a href="#<strong>displays</strong>" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Set defaults for <strong>Latitude</strong> and <strong>Longitude</strong> for all Geo aware previews throughout the CMS.</p>
|
||||
<h3>Default Layout</h3>
|
||||
<p>The Default Layout set here will be automatically assigned to all Displays to be shown when no other content is scheduled or if there is an issue which prevents a scheduled Event from being shown.</p>
|
||||
<p>This global Default Layout can be overridden for individual Displays by selecting an alternative <a href="displays.html#content-default-layout">Default Layout</a> to be used.</p>
|
||||
<h3>Proof of Play Default Settings</h3>
|
||||
<p>Set the <strong>Aggregation level</strong> of collection of <a href="displays_metrics.html">Proof of Play</a> statistics to be applied to all <strong>Layouts</strong> / <strong>Media</strong> and <strong>Widget items</strong> as default.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Individual</strong> - statistics are recorded at the start and finish of each item individually and sent back to the CMS at each collection interval.</li>
|
||||
<li>
|
||||
<strong>Hourly</strong> - records each item once, and includes the total number of times played and the length of time played during the hour and is sent back to the CMS on the next collection interval after the hour period has expired.</li>
|
||||
<li>
|
||||
<strong>Daily</strong> - records each item once, and includes the total number of times played and the length of time played during the day and is sent back to the CMS on the next collection interval after the day has expired.</li>
|
||||
</ul>
|
||||
<blockquote class="tip"><p>Players aggregate ‘completed records’ only, with collection made at the end of the Widgets duration so if a Widget has a duration of 3 hours, the stat will be recorded once the Widget has expired!</p>
|
||||
</blockquote>
|
||||
<ul>
|
||||
<li>Use this box to <strong>enable the collection</strong> of Proof of Play statistics to all <strong>Displays</strong> as default.</li>
|
||||
</ul>
|
||||
<blockquote class="tip"><p>This can be toggled on/off by editing <a href="displays_settings.html#content-editing-profiles">Display Setting Profiles</a>.</p>
|
||||
</blockquote>
|
||||
<ul>
|
||||
<li>Tick the box to set the default to on for the collection of Proof of Play statistics for all newly added <strong>Layouts</strong>.</li>
|
||||
</ul>
|
||||
<blockquote class="tip"><p>Collection can be disabled by unticking the box on the <strong>Add/Edit</strong> Layout form.</p>
|
||||
</blockquote>
|
||||
<p>Use the settings to enable the collection of Proof of Play statistics to apply to all <strong>Media</strong>, <strong>Playlist</strong> and <strong>Widgets</strong> (Off/On/Inherit).</p>
|
||||
<blockquote class="tip"><p>It is intended to have <strong>Widget</strong> always set to Inherit so that Layout and Media options control the collection!</p>
|
||||
</blockquote>
|
||||
<h2 id="general">General <a href="#general" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>View/set the address for the <strong>User Manual</strong> and tick to send <strong>anonymous statistics</strong> to help improve the software.</p>
|
||||
<h3>Tidy Library (Global)</h3>
|
||||
<p>The Library can be <em>tidied</em> by a Super Administrator or User so that it is kept clean and small.
|
||||
<strong>Actions cannot be reversed so this must be used with caution.</strong></p>
|
||||
<blockquote class="tip"><p>This might be of particular interest if the CMS is installed on a web server that has quotas or if Users have been assigned their own quotas.</p>
|
||||
</blockquote>
|
||||
<p>Administrators can initiate a system-wide Library tidy operation by clicking the <strong>Tidy Library</strong> button in the right hand corner of the Settings page:</p>
|
||||
<p><img src="img/v4_tour_cms_settings_tidy_library.png" alt="Settings Tidy Library" /></p>
|
||||
<p>As this functionality is system-wide and therefore operates on <strong>ALL</strong> User files, confirmation is required to remove unused and old revisions.</p>
|
||||
<p>This option is more comprehensive and removes:</p>
|
||||
<ul>
|
||||
<li>Temporary files</li>
|
||||
<li>Orphaned files</li>
|
||||
<li>Thumbnails</li>
|
||||
<li>Media revisions that aren’t used anywhere</li>
|
||||
<li>Media that isn’t used anywhere (on any Layouts / Display Groups / Displays)</li>
|
||||
<li>Generic files uploaded to the CMS</li>
|
||||
</ul>
|
||||
<h4>Orphaned files</h4>
|
||||
<p>Orphaned files are a rare occurrence where a file stored on disk in the Library folder is not deleted when the Media item is deleted from the Library. This means that the file exists but the CMS doesn’t know anything about it.</p>
|
||||
<h3>Tidy from User Library</h3>
|
||||
<p>Allow a User to tidy files from the <a href="media_library.html#content-tidy-library">Library</a> page by using the checkbox to <strong>Enable Library Tidy</strong>.</p>
|
||||
<h2 id="maintenance">Maintenance <a href="#maintenance" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>From here <strong>Enable Maintenance</strong> and <strong>Email Alerts</strong> to be sent and set the maximum retention ages for <strong>Logs</strong> and <strong>Statistics</strong>.</p>
|
||||
<h2 id="network">Network <a href="#network" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>From the Network tab complete an <strong>Admin email address</strong> for the overall CMS administrator. All email notifications generated by the CMS will be sent to this address.</p>
|
||||
<p>Ensure that the <strong>Sending email address</strong> and <strong>name</strong> is completed prior to setting up any further email notifications throughout the CMS.</p>
|
||||
<h2 id="sharing">Sharing <a href="#sharing" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Use the dropdown to change how Widget colour appears in Playlists for Users.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Media Colouring</strong> will use the colours from the <strong>theme</strong> for each Widget.</li>
|
||||
<li>
|
||||
<strong>Sharing Colouring</strong> will show the Widget colour based on <strong>User access</strong> from <strong>Sharing</strong> options. (Green = editable)</li>
|
||||
</ul>
|
||||
<p>From here you can set if Users should have the ability to schedule to Displays when Share options are set to View for the User as well as being able to set whether Users should be able to see the names of Layouts in schedules that have not been shared with them.</p>
|
||||
<p>Tick to allow Users to save their content into the top level <a href="configure_folders.html">Root Folder</a> or disable to force Users to select a Folder to save to.</p>
|
||||
<h2 id="regional">Regional <a href="#regional" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>From this tab set the <strong>Language</strong> and default <strong>Timezone</strong> and <strong>Date Format</strong> to use across the CMS.</p>
|
||||
<blockquote class="tip"><p>Select the nearest major city in your timezone!</p>
|
||||
</blockquote>
|
||||
<p>Use the checkbox to detect the <strong>browser language</strong> to use for the CMS and select which type of <strong>Calendar</strong> should be used.</p>
|
||||
<h2 id="troubleshooting">Troubleshooting <a href="#troubleshooting" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>This tab is used to to set Log Levels which are useful for capturing php errors and environment issues.</p>
|
||||
<h2 id="users">Users <a href="#users" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Select the System User and set the Default User Group and User Type when onboarding new Users.</p>
|
||||
<blockquote class="tip"><p>We recommend that the <strong>Default User Type</strong> is set to <strong>User</strong>!</p>
|
||||
</blockquote>
|
||||
<h3>Password Policy</h3>
|
||||
<p>Enter any valid regular expression in the <strong>Password Policy Regular Expression</strong> field so all password change requests and newly created passwords are tested against this.</p>
|
||||
<blockquote class="tip"><p>A text description will be shown to Users when their passwords do not meet the required policy as a prompt!</p>
|
||||
</blockquote>
|
||||
<h3>Password Reminder</h3>
|
||||
<p>Enable to provide a <strong>Forgotten your Password</strong> reset link for <strong>Users</strong> at login so they can easily regain access to the CMS.</p>
|
||||
<blockquote class="tip"><p>Ensure that a valid <strong>Sending email address</strong> has been entered on the <strong>Network</strong> tab before enabling this functionality!</p>
|
||||
</blockquote>
|
||||
<p>The User will be shown a link which once clicked will send a <strong>Password Reset Notification</strong> to their email address as recorded on their User Profile.</p>
|
||||
<blockquote class="tip"><p><strong>Users</strong> can also change their own passwords, once logged into the CMS, from their <strong>User Profile</strong>.</p>
|
||||
</blockquote>
|
||||
<h2 id="two_factor_authentication">Two Factor Authentication <a href="#two_factor_authentication" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="index.html">Two Factor Authentication</a> can be set by a User for added security once logged in.</p>
|
||||
<p>Once configured, a User would need to enter the code sent via email or as displayed in the Google Authenticator app to complete login to gain access to the CMS.</p>
|
||||
<blockquote class="tip"><p>Ensure that an Email address has been provided by the user to receive the generated email!</p>
|
||||
</blockquote>
|
||||
<p>Set a valid <strong>Sending email address</strong> has been entered on the <strong>Network</strong> tab and a name has been entered in the <strong>Two Factor Issuer</strong> field to make it clear on the Google Authenticator app and email when authenticated codes are generated for login to the CMS.</p>
|
||||
<p>Reset Two Factor Authentication for Users from their User Profile.</p>
|
||||
<h2 id="applications">Applications <a href="#applications" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>OTS Signs Command Center contains an API that allows 3rd party applications to connect and consume its data.</p>
|
||||
<p>Applications are added and configured from <strong>Applications</strong> under the <strong>Administration</strong> section of the main CMS menu.</p>
|
||||
<blockquote class="tip"><p>Before using an Application, each User must authorise the application to act on their behalf within the CMS.
|
||||
Users can view authorised Applications from the My Applications section of their <strong>User Profile</strong>.</p>
|
||||
</blockquote>
|
||||
<p>At the current time the CMS does not provide individual Users with a method of revoking access to an application. Only an Administrator can remove an application completely.</p>
|
||||
<h2 id="fonts">Fonts <a href="#fonts" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>OTS Signs Command Center comes with a set of standard fonts which can be set on many Widgets:</p>
|
||||
<ul>
|
||||
<li>Aileron Heavy Regular (Aileron-Heavy.otf)</li>
|
||||
<li>Aileron Regular (Aileron-Regular.otf)</li>
|
||||
<li>Dancing Script Regular (DancingScript-Regular.ttf)</li>
|
||||
<li>Railway Regular (Railway.ttf)</li>
|
||||
<li>Linear Regular (linear-by-braydon-fuller.otf)</li>
|
||||
</ul>
|
||||
<p>Manage from the <strong>Fonts</strong> page under the <strong>Administration</strong> section of the main CMS menu.</p>
|
||||
<ul>
|
||||
<li>Use the row menu to view a Fonts <strong>Details</strong> and see an example of the font style:</li>
|
||||
</ul>
|
||||
<p><img src="img/v4_tour_settings_fonts.png" alt="Font Details" /></p>
|
||||
<p>Additional fonts can be added by clicking the <strong>Upload Font</strong> button and using the file uploader tool.</p>
|
||||
<blockquote class="tip"><p>If the new font does not show in the text editor after upload, try clearing the browser cache!</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>
|
||||
200
manual/en/configure_folders.html
Normal file
@@ -0,0 +1,200 @@
|
||||
<!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="configure">
|
||||
<!-- 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><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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<p><a href="configure_cms_settings.html">Configure CMS Settings</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="configure_tags.html">Tags</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p class="active"><a href="configure_folders.html">Folders</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="configure_transitions.html">Transitions</a></p>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<li><a href="troubleshooting.html" data-toc-name="troubleshooting">Troubleshooting</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-md-9" role="main">
|
||||
<h1 id="folders">Folders <a href="#folders" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Folders are used throughout the CMS and provide a great way to organise and easily locate user items within the CMS. Additionally Folders can have view, edit, delete sharing options applied which will apply to all items saved to the Folder, making it an efficient way to control User/User Group permissions for User items.</p>
|
||||
<p>Administrators are encouraged to assign User Groups to their Users, and then use Folder Share options to give these Users appropriate access to each other’s content. Folders can be assigned to new Users from the on-boarding wizard to ensure that they are up and running from the start.</p>
|
||||
<p>Folders are managed from the Administration section of the main CMS menu where administrators can see detailed information including who the Folder has been shared with and a breakdown of its contents.</p>
|
||||
<h3>Creating Folders</h3>
|
||||
<p>Only administrators can create <strong>Folders</strong> under the <strong>Root Folder</strong>.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Right click the <strong>Root Folder</strong> and select <strong>Create</strong> to add a new Folder to the tree.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Further options are available from the context menu by right clicking a Folder.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Configure View, Edit and Delete <strong>Share</strong> options to apply to Users/User Groups for individual Folders.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Once set, all items contained or moved to that Folder will inherit the applied options.</p>
|
||||
<blockquote class="tip"><p>Only Administrators can set Share options for Folders.
|
||||
All elements of an item that need to be shared should also be moved to the Folder. This includes Media files contained on Layouts, and Layouts within Campaigns, as an example, if Users also require access to those.</p>
|
||||
</blockquote>
|
||||
<p>Users can be granted access via the <strong>Feature</strong> functionality, to create sub-folders under parent folders they have been given access to.</p>
|
||||
<p>Sub-Folders added to a Folder will inherit any applied Share options from the Main Folder.</p>
|
||||
<h3>Home Folder</h3>
|
||||
<p>Assign a Home Folder to existing Users:</p>
|
||||
<ul>
|
||||
<li>Go to <strong>Users</strong> under the <strong>Administration</strong> section of the main CMS menu.</li>
|
||||
<li>Use the row menu and select <strong>Set Home Folder</strong>.</li>
|
||||
<li>Select a Folder to use, or right click to create a new Folder.</li>
|
||||
</ul>
|
||||
<blockquote class="tip"><p>If you want Group Administrator to have the ability to set Home Folder for Users, ensure that they have the appropriate <strong>Feature</strong> enabled!</p>
|
||||
</blockquote>
|
||||
<p>If a Folder is not selected, new content will automatically save into a Users default Home Folder location.</p>
|
||||
<h3>Force Saving to a Folder</h3>
|
||||
<p>Administrators can prevent Users from saving into the Root Folder and instead force them to select a Folder before saving by disabling the user of the Root Folder as a default:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Navigate to <strong>Settings</strong> under the <strong>Administration</strong> section of the main CMS menu.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click on the <strong>Sharing</strong> tab.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Untick <strong>Allow saving in the root folder</strong> option.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click the <strong>Save</strong> button at the bottom.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Once configured a User <em><strong>must</strong></em> select a named Folder.</p>
|
||||
<h3>Move Folder</h3>
|
||||
<p>Folders can be moved to another Folder location and added as a Sub-Folder using the <strong>Move Folder</strong> option from the context menu for a Folder.</p>
|
||||
<p>The Folder and any contained sub-folders will be moved as a new sub-folder within the new Folder location maintaining the original Folder structure.</p>
|
||||
<p>Moving a Folder that does not have any Share options set, will inherit any applied <strong>Share</strong> options of the destination Folder.</p>
|
||||
<p>You can also select the <strong>Merge</strong> option to add the original Folder contents to the selected location, with the original Folder being deleted from the Folder tree.</p>
|
||||
<h2 id="folder_management">Folder Management <a href="#folder_management" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Administrators can view, create and manage all Folders of the CMS from the Folders page under the Administration section of the main CMS menu.</p>
|
||||
<p>This management page will show the Folders that have been shared with Users as well as folder contents. When viewing sub-folders from here, only the directly assigned share options will be shown, inherited options will not be shown.</p>
|
||||
<p>As only empty folders can be removed, move, merge or delete contents before removing the folder.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="configure_tags.html">Managing Tags</a></p>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em><strong>Where can I find the Feature set for Folders to configure for Users/User Groups?</strong></em></p>
|
||||
<p>Features are applied to a User/User Group by using the row menu for a selected User/User Group.</p>
|
||||
<p><em><strong>What steps should I take take to allow Users the ability to Create their own Folders?</strong></em></p>
|
||||
<ol>
|
||||
<li>Enable <strong>Allow users to create Sub-Folders….</strong> from the Content tab of the <strong>Folders Feature</strong> set.</li>
|
||||
<li>Enable <strong>View</strong> from the <strong>Share options</strong> for the parent folders(s) that can have sub-folders created under them by the User/User Group.</li>
|
||||
</ol>
|
||||
<p><em><strong>What steps should I take to allow Users access to rename Folders within the menu?</strong></em></p>
|
||||
<ol>
|
||||
<li>Enable <strong>Rename and Delete existing folders</strong> from the Content tab on the <strong>Folders Feature</strong> set.</li>
|
||||
<li>Enable <strong>Edit</strong> from the <strong>Share options</strong> for the folder(s) that can be renamed by the User/User Group.</li>
|
||||
</ol>
|
||||
<p><em><strong>What steps should I take to allow Users access to delete Folders from the menu?</strong></em></p>
|
||||
<ol>
|
||||
<li>Enable <strong>Rename and Delete existing Folders</strong> from the Content tab on the <strong>Folders Feature</strong> set.</li>
|
||||
<li>Enable <strong>Delete</strong> from the <strong>Share options</strong> for the folder(s) that can be removed by the User/User Group</li>
|
||||
</ol>
|
||||
|
||||
</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>
|
||||
152
manual/en/configure_tags.html
Normal file
@@ -0,0 +1,152 @@
|
||||
<!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="configure">
|
||||
<!-- 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><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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<p><a href="configure_cms_settings.html">Configure CMS Settings</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p class="active"><a href="configure_tags.html">Tags</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="configure_folders.html">Folders</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="configure_transitions.html">Transitions</a></p>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<li><a href="troubleshooting.html" data-toc-name="troubleshooting">Troubleshooting</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-md-9" role="main">
|
||||
<h1 id="tags">Tags <a href="#tags" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Tags are used throughout the CMS in order to easily organise and categorise items to make it easier for Users to locate and use. Tags act as keywords or labels which when assigned to items enhances the search functionality for Users.</p>
|
||||
<p>Tags can be created by Users from various forms throughout the CMS, as well as created and managed by Administrators from the Tags page under the Administration section of the main CMS menu.</p>
|
||||
<p>Create and assign <strong>Tags</strong> to items throughout the CMS using the Tag field on forms. As text is entered, an auto-complete helper will show possible matches to make it easier for Users to see what Tags are already available to select from:</p>
|
||||
<ul>
|
||||
<li>Select a <strong>Tag</strong> from the list or create a new one by directly typing in the Tag field.</li>
|
||||
</ul>
|
||||
<p>Tags can also be be created by Administrators from the <strong>Tags</strong> page under the <strong>Administration</strong> section of the main CMS menu.</p>
|
||||
<ul>
|
||||
<li>Click the <strong>Add Tag</strong> button and give it a <strong>Name</strong>.</li>
|
||||
</ul>
|
||||
<p>Tags can optionally have Tag Values associated with them. For example, you could have a Reception Tag, with reception areas across multiple sites. These could be differentiated using Values by creating a comma separated string of numbers, 1,2,3.</p>
|
||||
<p>The <strong>Required Value</strong> checkbox is used to ensure that a User <em><strong>must</strong></em> select a Value in order to successfully assign the Tag to the item.</p>
|
||||
<p>Once enabled, when the Tag is selected by Users, any associated Values will be shown for selection. A warning message will be shown to Users who do not select a Value to prompt them to do so.</p>
|
||||
<p>Users can also add associated Values to Tags using the <strong>Tag Value</strong> field in forms.</p>
|
||||
<p>Administrators can view all <strong>System Tags</strong> from the Tag management page and view Usage reports using the row menu for each individual Tag.</p>
|
||||
<p>Use the <strong>With Selected</strong> option at the bottom of the grid to <strong>Delete</strong> Tags in bulk.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="configure_folders.html">Managing Folders</a></p>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em>Can I use filter options to exclude Tags from searches?</em></p>
|
||||
<ul>
|
||||
<li>Enter <code>-Tag</code> to exclude the tag from search results.</li>
|
||||
<li>Enter <code>-|Value</code> to exclude the value from search results.</li>
|
||||
<li>Enter <code>-Tag|Value</code> to exclude both tag and value from search results.</li>
|
||||
</ul>
|
||||
<p>You can have a comma separated mix of all the above!</p>
|
||||
<ul>
|
||||
<li>If you want to show all items that have <strong>not</strong> got a tag then enter <code>--no-tag</code>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</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>
|
||||
141
manual/en/configure_transitions.html
Normal file
@@ -0,0 +1,141 @@
|
||||
<!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="configure">
|
||||
<!-- 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><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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<p><a href="configure_cms_settings.html">Configure CMS Settings</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="configure_tags.html">Tags</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="configure_folders.html">Folders</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p class="active"><a href="configure_transitions.html">Transitions</a></p>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<li><a href="troubleshooting.html" data-toc-name="troubleshooting">Troubleshooting</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-md-9" role="main">
|
||||
<h1 id="transition_management">Transition Management <a href="#transition_management" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Transitions are managed from the <strong>Transitions</strong> page under the <strong>Administration</strong> section of the main CMS menu. Configure which Transitions should be available to Users for assignment to Media items:</p>
|
||||
<p><img src="img/v4_tour_transitions_grid.png" alt="Transitions Grid" /></p>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Fade In</strong> - Increase Opacity from 0 to 100.</li>
|
||||
<li>
|
||||
<strong>Fade Out</strong> - Decrease Opacity from 100 to 0.</li>
|
||||
<li>
|
||||
<strong>Fly</strong> - Fly in or out on a compass point.</li>
|
||||
</ul>
|
||||
<h2 id="transition_defaults">Transition Defaults <a href="#transition_defaults" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Default Transitions can be easily enabled for all Widgets added to a Layout by ticking the <strong>Automatically apply Transitions?</strong> box from the Layout property panel:</p>
|
||||
<p><img src="img/v4_tour_transitions_layout.png" alt="Transitions Layout" /></p>
|
||||
<h2 id="playlist_transitions">Playlist Transitions <a href="#playlist_transitions" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>These are the Transitions between <strong>Media items</strong> on a <a href="media_playlists.html">Playlist</a> and are set as <strong>In</strong> and <strong>Out</strong> transitions.</p>
|
||||
<blockquote class="tip"><p>The Transition form adapts depending on the Transition selected and the options available for that transition. In most cases it is necessary to select a duration for the Transition in Milliseconds and in the case of Fly, a direction must also be selected.</p>
|
||||
</blockquote>
|
||||
<h2 id="playlist_exit_transition">Playlist Exit Transition <a href="#playlist_exit_transition" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>A Playlist Exit Transition happens when the last Media Item to be displayed on a <a href="media_playlists.html">Playlist</a> is shown and allows for a different Exit Transition to be set.</p>
|
||||
|
||||
</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>
|
||||
160
manual/en/contact_support.html
Normal file
@@ -0,0 +1,160 @@
|
||||
<!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="contact_support">
|
||||
<!-- 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><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><li><a href="contact_support.html" data-toc-name="contact_support">Contact Support</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-md-9" role="main">
|
||||
<h1 id="contact_support">Contact Support <a href="#contact_support" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>We're here to help! If you have questions or need assistance with OTS Signs Command Center, please don't hesitate to reach out to our support team. We're committed to providing prompt and professional support to ensure your digital signage system runs smoothly.</p>
|
||||
|
||||
<h2 id="support_options">Support Options <a href="#support_options" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
|
||||
<h3 id="create_support_ticket">Create a Support Ticket</h3>
|
||||
<p>For technical issues, feature requests, or general inquiries, we recommend creating a support ticket through our portal. This allows us to track your request and provide you with timely updates.</p>
|
||||
<p><a href="https://portal.oribi-tech.com/new-ticket" class="btn btn-primary" target="_blank">Create a New Support Ticket</a></p>
|
||||
|
||||
<h3 id="email_support">Email Support</h3>
|
||||
<p>You can also reach our support team directly via email at <a href="mailto:support@ots-signs.com">support@ots-signs.com</a>. Please include any relevant details about your issue, such as:</p>
|
||||
<ul>
|
||||
<li>A description of the problem or question</li>
|
||||
<li>Steps you've taken to try to resolve the issue</li>
|
||||
<li>Your OTS Signs Command Center version number</li>
|
||||
<li>Information about your system setup (number of displays, display types, etc.)</li>
|
||||
<li>Any error messages you've encountered</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="support_resources">Support Resources <a href="#support_resources" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Before contacting support, you may find answers to your questions in our documentation:</p>
|
||||
<ul>
|
||||
<li><a href="troubleshooting.html">Troubleshooting Guide</a> - Common issues and solutions</li>
|
||||
<li><a href="index.html">User Manual</a> - Comprehensive documentation and user guides</li>
|
||||
<li><a href="getting_started_showing_a_video.html">Getting Started</a> - Quick start guides for new users</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="what_to_expect">What to Expect <a href="#what_to_expect" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>When you contact our support team, you can expect:</p>
|
||||
<ul>
|
||||
<li><strong>Professional Service:</strong> Our experienced support specialists are knowledgeable about OTS Signs Command Center</li>
|
||||
<li><strong>Prompt Response:</strong> We aim to acknowledge all support requests within 24 business hours</li>
|
||||
<li><strong>Dedicated Assistance:</strong> Your support ticket is tracked from submission to resolution</li>
|
||||
<li><strong>Quality Solutions:</strong> We work with you to diagnose and resolve issues efficiently</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="tips_for_faster_resolution">Tips for Faster Resolution <a href="#tips_for_faster_resolution" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>To help us assist you more quickly, please provide:</p>
|
||||
<ul>
|
||||
<li>Clear and detailed descriptions of the problem</li>
|
||||
<li>Steps to reproduce the issue, if applicable</li>
|
||||
<li>Screenshots or error messages that illustrate the problem</li>
|
||||
<li>Your system configuration details</li>
|
||||
<li>Any troubleshooting steps you've already attempted</li>
|
||||
</ul>
|
||||
|
||||
<h2 id="other_resources">Additional Resources <a href="#other_resources" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>For additional information and resources:</p>
|
||||
<ul>
|
||||
<li>Review the <a href="troubleshooting.html">Troubleshooting Guide</a> for solutions to common problems</li>
|
||||
<li>Explore the <a href="configure_cms_settings.html">Configuration and Organisation</a> section for system setup guidance</li>
|
||||
<li>Check the <a href="displays.html">Displays</a> documentation for device management assistance</li>
|
||||
</ul>
|
||||
|
||||
<p><strong>Thank you for choosing OTS Signs Command Center! We're excited to help you succeed with your digital signage deployment.</strong></p>
|
||||
|
||||
</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>
|
||||
173
manual/en/displays.html
Normal file
@@ -0,0 +1,173 @@
|
||||
<!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="displays">
|
||||
<!-- 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><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><!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="displays.html">Displays</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_configuration.html">Display Configuration</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_settings.html">Display Settings</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_groups.html">Display Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_sync_groups.html">Sync Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_metrics.html">Reporting</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_command_functionality.html">Command Functionality</a>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<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="what_is_a_display?">What is a Display? <a href="#what_is_a_display?" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>OTS Signs Command Center helps you display content on your screens; whether you have existing content or need to create your own, to show on 1 screen or a 100.000, OTS Signs Command Center makes it easy!</p>
|
||||
<p>OTS Signs Command Center uses the concept of Displays which are managed from the CMS to control when and how content is shown as well as provide device management tools for Users.</p>
|
||||
<p>A <strong>Display</strong> is an essential part of digital signage as is it bridges the communication between the <strong>CMS</strong> software (Content Management System) and <strong>Media Player App</strong>.</p>
|
||||
<p>The <strong>Player App</strong> is installed onto a <strong>Media Player</strong>, which can be a separate physical hardware device attached to a screen or an integrated Media Player found in supported System on Chip (SoC) professional signage monitors. A hardware key is generated on installing the Player App which creates a unique <strong>Display</strong> record in the CMS.</p>
|
||||
<p>Once installed, the Player App must be <strong>Connected</strong> to the CMS by using a <strong>Code</strong> or by providing a <strong>CMS Key</strong>. Once connected a <strong>Display</strong> will be registered awaiting <strong>Authorisation</strong> in the CMS before it will become a managed device and start displaying content from the CMS.</p>
|
||||
<h2 id="creating_a_display">Creating a Display <a href="#creating_a_display" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<ol>
|
||||
<li>
|
||||
<strong>Download</strong> the Player App</li>
|
||||
<li>
|
||||
<strong>Install</strong> to the Player device. Some supported (SoC) System on Chip models will already have the Player App installed.</li>
|
||||
<li>
|
||||
<strong>Connect</strong> the Player App to the CMS.</li>
|
||||
<li>
|
||||
<strong>Authorise</strong> the Display using the row menu from the <strong>Displays</strong> page in the CMS.</li>
|
||||
</ol>
|
||||
<p>The Display will regularly connect to the CMS to check for any updated <a href="scheduling_events.html">schedule</a> information or any new content to download. The Displays grid will update to show the status, indicate if the Display has logged in recently, show the date and time stamp of when the Display was last accessed etc, to help you manage your network.</p>
|
||||
<blockquote class="tip"><p>Any updates will be downloaded and saved to the Player App. This means that if a connection issue were to arise between the Display and CMS, the Display would continue to show scheduled content offline until the connection was restored.</p>
|
||||
</blockquote>
|
||||
<p>Manage <strong>Displays</strong> from the CMS and use the range of device management tools to effectively control your network. You can organise Displays into <a href="displays_groups.html">Display Groups</a>, apply configuration using <a href="displays_settings.html">Display Setting Profiles</a>, and monitor performance with <a href="displays_metrics.html">Reporting</a>.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="displays_configuration.html">Display Configuration</a></p>
|
||||
<p><a href="displays_groups.html">Create Display Groups</a></p>
|
||||
<p><a href="displays_settings.html">Apply settings using Display Profiles</a></p>
|
||||
<p><a href="displays_sync_groups.html">Sync Groups</a></p>
|
||||
<p><a href="displays_metrics.html">Reporting & Metrics</a></p>
|
||||
<h2 id="see_also">See Also <a href="#see_also" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<ul>
|
||||
<li><a href="scheduling_events.html">Scheduling Events</a> — schedule content to show on your Displays</li>
|
||||
<li><a href="layouts_editor.html">Layout Editor</a> — create the content your Displays will show</li>
|
||||
<li><a href="media_library.html">Media Library</a> — manage media files used in your content</li>
|
||||
<li><a href="troubleshooting.html">Troubleshooting</a> — resolve common Display connection issues</li>
|
||||
</ul>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em><strong>Which Players can connect to the CMS using code?</strong></em></p>
|
||||
<p>All Players, at the latest version support connecting via a code, with the exception of the Linux Player.</p>
|
||||
<p><em><strong>Can I easily transfer a Display to another CMS?</strong></em></p>
|
||||
<p>First you need to ensure that you have Two Factor Authentication set up, from the User Profile to use Transfer to another CMS setting from a Display row menu. Multiple Displays can be transferred using the With Selected option at the bottom of the Displays grid.</p>
|
||||
<p><em><strong>Do the Player and CMS versions have to match?</strong></em></p>
|
||||
<p>Our recommendation is that your CMS and Players should be of the same major version for the best results.</p>
|
||||
<p><em><strong>What does it mean to Assign Files / Assign Layouts?</strong></em></p>
|
||||
<p>Library files and Layouts can be directly assigned to a Display so that they are always available in the local library of the Player. This is useful for pre-loading a Layout ahead of time when the Layout will be used for some API integration to trigger a change for example. Content will still need to be scheduled to show on Displays.</p>
|
||||
|
||||
</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>
|
||||
293
manual/en/displays_command_functionality.html
Normal file
@@ -0,0 +1,293 @@
|
||||
<!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="displays">
|
||||
<!-- 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><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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<a href="displays.html">Displays</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_configuration.html">Display Configuration</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_settings.html">Display Settings</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_groups.html">Display Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_sync_groups.html">Sync Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_metrics.html">Reporting</a>
|
||||
</li>
|
||||
<li class="active">
|
||||
<a href="displays_command_functionality.html">Command Functionality</a>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<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="command_functionality">Command Functionality <a href="#command_functionality" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>The Command Functionality in OTS Signs Command Center is used to configure a set of Commands for a User to select to execute via <strong>XMR</strong>, in a <strong>Schedule</strong> or include in a <strong>Layout</strong>.</p>
|
||||
<blockquote class="tip"><p>Commands can have Command Strings to apply to all Players or have a different Command String per Player which is particularly useful if your network is mixed / connected to different Displays or have slightly different Player hardware.</p>
|
||||
</blockquote>
|
||||
<p>A <strong>Command record</strong> is created which allows for a “generic command” to be created which can be used across <strong>Display Profiles</strong>, <strong>Scheduled Events</strong> and the <strong>Shell Command Widget</strong>.</p>
|
||||
<blockquote class="tip"><p>Commands provide easy access to functionality for RS232, Android Intents and Philips SoC (system on chip)!</p>
|
||||
</blockquote>
|
||||
<h2 id="command_management">Command Management <a href="#command_management" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Commands are created and managed from <strong>Commands</strong> under the <strong>Displays</strong> section of the main CMS menu:</p>
|
||||
<p><img src="img/v4_displays_commands.png" alt="Display Commands" /></p>
|
||||
<p>Use the row menu for a Command to Edit, Delete and set <a href="users_features_and_sharing.html#content-share">Share</a> options.</p>
|
||||
<h3>Add Command</h3>
|
||||
<p>Click on the <strong>Add Command</strong> button and complete the relevant form fields:</p>
|
||||
<p><img src="img/v4_displays_commands_add_command.png" alt="add_command" /></p>
|
||||
<p>Use the <strong>Command</strong> drop down menu to select from one of the following options to configure:</p>
|
||||
<h4>Free Text</h4>
|
||||
<p>Type in a Command String</p>
|
||||
<blockquote class="tip"><p>The Command String represents the final executed Command and can be a direct call to the shell or can have a <strong>helper</strong> specified, see “Helpers” section below.</p>
|
||||
</blockquote>
|
||||
<h4>Philips Android</h4>
|
||||
<p>The following commands can be used to control LED’s located on the sides of some commercial Phillips Displays:</p>
|
||||
<pre><code>tpv_led|off
|
||||
tpv_led|red
|
||||
tpv_led|green
|
||||
tpv_led|blue
|
||||
tpv_led|white
|
||||
</code></pre>
|
||||
<p>From Android v2 R215, integration has been added to power on/off the screen backlight by using the following commands:</p>
|
||||
<pre><code>tpv|backlighton
|
||||
tpv|backlightoff
|
||||
</code></pre>
|
||||
<blockquote class="tip"><p>The below commands can be used for one specific Android 4 model only; 2016 model <a href="https://www.philips.co.uk/p-p/10BDL3051T_00/signage-solutions-multi-touch-display">10BDL3051T</a></p>
|
||||
<pre><code>tpv|screenoff
|
||||
tpv|screenon
|
||||
</code></pre>
|
||||
<p><code>screenoff</code> will turn the screen off and put in a lower power state which can then be turned back on with <code>screenon</code>.</p>
|
||||
<p>For all other models, please use <code>backlighton/off</code> as <code>screenoff</code> will power completely off resulting in the need for an on site restart!</p>
|
||||
</blockquote>
|
||||
<p>Mute/unmute commands have also been added from v2 R215:</p>
|
||||
<pre><code>tpv|mute
|
||||
tpv|unmute
|
||||
</code></pre>
|
||||
<p><strong>Please note:</strong> <code>backlighton/off</code> doesn’t mute audio, so if you have audio playing you will will also want to schedule the above <code>mute/unmute</code> commands at the same time.</p>
|
||||
<h4>RS232</h4>
|
||||
<p>RS232 commands can be executed on Players by using the <code>rs232</code> prefix in the Command String. The format of the command is <code>rs232|<connection string>|<command></code>.</p>
|
||||
<p>The connection string should be provided in the following format on Windows:</p>
|
||||
<pre><code><COM#>,<Baud Rate>,<Data Bits>,<Parity|None,Odd,Even,Mark,Space>,<StopBits|None,One,Two,OnePointFive>,<Handshake|None,XOnXOff,RequestToSend,RequestToSendXOnXOff>,<HexSupport|0,1,default 0>
|
||||
</code></pre>
|
||||
<p><strong>Please note:</strong> If you need to send your Command in HEX format, you should specify the byte string in the Command String, for example: <code>7E 00 00 FF 00 00 00 00 00 00 00 00 00 00 00 00 00 FF</code> , this will be converted to a byte stream by the player. You will need to set the <code>HexSupport</code> element of the connection string to <code>1</code>.</p>
|
||||
<p>The connection string should be provided in the following format on Android:</p>
|
||||
<pre><code><DeviceName>,<Baud Rate>,<Data Bits>,<Parity>,<StopBits>,<FlowControl>
|
||||
</code></pre>
|
||||
<p>Each setting is represented by a corresponding number:</p>
|
||||
<pre><code>DATA_BITS_5 = 5;
|
||||
DATA_BITS_6 = 6;
|
||||
DATA_BITS_7 = 7;
|
||||
DATA_BITS_8 = 8;
|
||||
PARITY_NONE = 0;
|
||||
PARITY_ODD = 1;
|
||||
PARITY_EVEN = 2;
|
||||
PARITY_MARK = 3;
|
||||
PARITY_SPACE = 4;
|
||||
STOP_BITS_1 = 1;
|
||||
STOP_BITS_15 = 3;
|
||||
STOP_BITS_2 = 2;
|
||||
FLOW_CONTROL_OFF = 0;
|
||||
FLOW_CONTROL_RTS_CTS = 1;
|
||||
FLOW_CONTROL_DSR_DTR = 2;
|
||||
FLOW_CONTROL_XON_XOFF = 3;
|
||||
</code></pre>
|
||||
<p>The Command itself is a string which gets sent over RS232 using the connection details.</p>
|
||||
<h4>Android Intent</h4>
|
||||
<p>Android Display Profiles can use the <code>intent</code> helper to specify an intent that should be called when the Command executes. The format of the Command is <code>intent|<type|activity,service,broadcast>|<activity>|[<extras>]</code> .</p>
|
||||
<p><code>[<extras>]</code> is an optional parameter available from <strong>Android v2 R206</strong> used to provide additional data to the Intent. This must be a JSON formatted string containing an array with at least one object. The object format is below and must be on one line.</p>
|
||||
<pre><code class="language-json">{
|
||||
"name": "<extra name>",
|
||||
"type": "<type|string,int,bool,intArray>",
|
||||
"value": <the value of the above type>
|
||||
}
|
||||
</code></pre>
|
||||
<p>For example, on some devices you can program the firmware to set on/off times.</p>
|
||||
<pre><code>[{
|
||||
"name": "timeon",
|
||||
"type": "intArray",
|
||||
"value": [2018, 7, 28, 8, 40]
|
||||
}, {
|
||||
"name": "timeoff",
|
||||
"type": "intArray",
|
||||
"value": [2018, 7, 28, 21, 40]
|
||||
}]
|
||||
</code></pre>
|
||||
<p>This would be set on the command as:</p>
|
||||
<pre><code>intent|broadcast|activity|[{ "name": "timeon", "type": "intArray", "value": [2018, 7, 28, 8, 40] }, { "name": "timeoff", "type": "intArray", "value": [2018, 7, 28, 21, 40] }]
|
||||
</code></pre>
|
||||
<blockquote class="tip"><p>Commands containing an intent helper are ignored in the Windows Player!</p>
|
||||
</blockquote>
|
||||
<h3>Helpers</h3>
|
||||
<p><strong>Command Helpers</strong> are prefixes that can be added to the Command String in order to take a more advanced action. Commands without a prefix are executed in the shell of the operating system which runs the Player. <code>cmd.exe</code> on Windows and <code>shell</code> on Android.</p>
|
||||
<h3>Validation</h3>
|
||||
<p>The <strong>Validation String</strong> is used as a comparison to the <strong>Command</strong> output and if it matches then the Command is considered a success. The Validation String must be an exact match.</p>
|
||||
<p>This could be useful for a network of mixed Windows and Android Players with a command called ‘Reboot’. The Command String for ‘Reboot’ on Windows being <code>shutdown /r /t 0</code>, and on Android, it is <code>reboot</code>.</p>
|
||||
<blockquote class="tip"><p>The same can also be useful with a non-mixed network - imagine a network of Windows players with different monitors connected over HDMI/RS232. A single Command called ‘Monitor On’ can be created with the different brands of monitor represented by different Display Settings Profiles, each can have a different Command String to turn the monitor on/off.</p>
|
||||
</blockquote>
|
||||
<h3>Available on</h3>
|
||||
<p>Select which type of Display the Command will be available on, leave blank to apply the Command to all types of Display.</p>
|
||||
<blockquote class="tip"><p><strong>Command</strong> and <strong>Validation</strong> strings can be overridden by editing a <a href="displays_settings.html#setting_on_the_display">Display Profile</a> and using the <strong>Command</strong> tab!</p>
|
||||
</blockquote>
|
||||
<h2 id="send_command_xmr">Send Command XMR <a href="#send_command_xmr" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Execute Commands via <strong>XMR</strong> from Displays/Display Groups using the row menu:</p>
|
||||
<h2 id="scheduling_commands">Scheduling Commands <a href="#scheduling_commands" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><strong>Schedule Commands</strong> so that they are executed at a specific time</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Click on <strong>Schedule</strong> from the main CMS menu.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Select <a href="scheduling_events.html#content-add-event">Add Event</a> from the top of the Schedule grid.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>From the Event Type drop down select <strong>Command</strong>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Complete the form fields and select the <strong>Command</strong> to use and <strong>Start Time</strong>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<blockquote class="tip"><p>Scheduled commands are executed once on the Player and only require a <strong>Start</strong> date and time. The Command can be executed up to 10 seconds after the time selected.</p>
|
||||
</blockquote>
|
||||
<h2 id="shell_commands">Shell Commands <a href="#shell_commands" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Use the <a href="media_module_shellcommand.html">Shell Command Widget</a> to run external Commands based on the Layouts activity.</p>
|
||||
<p>Shell Commands with a Command as their source act in the same fashion as normal shell commands. The Command is executed when the Widget is shown on the Layout.</p>
|
||||
<p>A Shell Command can also be a Command String with options for all Players provided. This allows Users to add Commands ‘ad-hoc’ for one-time use.</p>
|
||||
<blockquote class="tip"><p>We recommend that Administrators create predefined commands when possible!</p>
|
||||
</blockquote>
|
||||
<h2 id="monitor_on/off">Monitor ON/OFF <a href="#monitor_on/off" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<h3>HDMI-CEC</h3>
|
||||
<p>HDMI-CEC is a bus that is implemented on nearly all new large-screen TVs that have HDMI connectors. This bus (which is physically connected within normal HDMI cables) supports control signals that can perform power-on, power off, volume adjusts, selection of video source and many of the features that are accessible via the TV’s remote control. It can also control most other hardware on the HDMI bus.</p>
|
||||
<p>OTS Signs Command Center doesn’t provide a direct interface to HDMI-CEC as there are many different manufacturer specifications, however, it is possible to control HDMI-CEC via a batch file.</p>
|
||||
<h3>Serial/RS232</h3>
|
||||
<p>Industry grade monitors often have a serial interface for turning the monitor panel on and off. OTS Signs Command Center can use the RS232 Command helper to send these Commands to the monitor - usually in HEX mode.</p>
|
||||
<p>The following monitors and Commands have been tested:</p>
|
||||
<h4>NEC E464</h4>
|
||||
<ul>
|
||||
<li>Power On - <code>rs232|COM1,9600,8,None,One,None,1|01 30 41 30 41 30 43 02 43 32 30 33 44 36 30 30 30 31 03 73 0d</code>
|
||||
</li>
|
||||
<li>Power Off - <code>rs232|COM1,9600,8,None,One,None,1|01 30 41 30 41 30 43 02 43 32 30 33 44 36 30 30 30 34 03 76 0d</code>
|
||||
</li>
|
||||
</ul>
|
||||
<h4>Sharp LC-42D69U</h4>
|
||||
<ul>
|
||||
<li>Power On - <code>rs232|COM1,9600,8,None,One,None,1|50 4F 57 52 31 20 20 20 0D</code>
|
||||
</li>
|
||||
<li>Power Off - <code>rs232|COM1,9600,8,None,One,None,1|50 4F 57 52 00 20 20 20 0D</code>
|
||||
</li>
|
||||
</ul>
|
||||
<h4>LG 55LK520</h4>
|
||||
<ul>
|
||||
<li>Power On - <code>rs232|COM1,9600,8,None,One,None,1|6B 61 20 30 30 20 30 31 0D</code>
|
||||
</li>
|
||||
<li>Power Off - <code>rs232|COM1,9600,8,None,One,None,1|6B 61 20 30 30 20 30 30 0D</code>
|
||||
</li>
|
||||
</ul>
|
||||
<blockquote class="tip"><p>It should be noted that other models of each brand should also use the same Commands.</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>
|
||||
173
manual/en/displays_configuration.html
Normal file
@@ -0,0 +1,173 @@
|
||||
<!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="displays">
|
||||
<!-- 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><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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<a href="displays.html">Displays</a>
|
||||
</li>
|
||||
<li class="active">
|
||||
<a href="displays_configuration.html">Display Configuration</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_settings.html">Display Settings</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_groups.html">Display Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_sync_groups.html">Sync Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_metrics.html">Reporting</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_command_functionality.html">Command Functionality</a>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<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="configuration_of_displays">Configuration of Displays <a href="#configuration_of_displays" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Once Displays have been connected, they are configured and managed from the <strong>Displays</strong> page inside the CMS.</p>
|
||||
<p>In order to start showing content, <strong>Displays</strong> must be <strong>Authorised</strong> with the CMS. Check the Displays grid to make sure the right Displays are showing as <strong>Authorised</strong>, as a first step.</p>
|
||||
<ul>
|
||||
<li>Give the <strong>Display</strong> a friendly name for easier identification within the CMS by using the <strong>Edit</strong> option from the row menu.</li>
|
||||
</ul>
|
||||
<p>Now is a great time to assign your Display a <strong>Default Layout</strong>. The Default Layout is shown when there is nothing else <a href="scheduling_events.html">scheduled</a>.</p>
|
||||
<ul>
|
||||
<li>Scroll down the form to select a <a href="layouts_editor.html">Layout</a> to use as the default. This Layout will be shown when there is no content scheduled or an issue arises that prevents scheduled content from showing on your Display.</li>
|
||||
</ul>
|
||||
<blockquote class="tip"><p>When creating your own Default Layouts, keep in mind that designs should be kept simple, avoiding any complex media and web content!</p>
|
||||
</blockquote>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Click on the <strong>Details</strong> tab to provide further information about your Display.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Setting the <strong>Latitude</strong> and <strong>Longitude</strong> of the Display, will show its location on the map view.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>The <strong>Displays</strong> map can be viewed by clicking the icon next to the <strong>Folders</strong> toggle from the Displays grid:</p>
|
||||
<p><img src="img/display_configuration_map_view_icon.png" alt="Display Map Icon" /></p>
|
||||
<ul>
|
||||
<li>Set <strong>Timezones</strong> to ensure that content is shown at the right time for your Display location.</li>
|
||||
</ul>
|
||||
<p>Each Display is assigned a default profile which will automatically apply its settings to all Displays of the same type. For example, you edit the Collect Interval for your Android Display Profile. Once saved, the new collection time will be applied to all Displays assigned this as a Display Profile.</p>
|
||||
<p><a href="displays_settings.html">Display Setting Profiles</a> can be customised for automatic management and configuration of your Display Network.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="displays.html">What is a Display?</a></p>
|
||||
<p><a href="displays_groups.html">Using Display Groups</a></p>
|
||||
<p><a href="displays_settings.html">Apply settings using Display Profiles</a></p>
|
||||
<h2 id="see_also">See Also <a href="#see_also" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<ul>
|
||||
<li><a href="scheduling_events.html">Scheduling Events</a> — schedule content to Displays once configured</li>
|
||||
<li><a href="displays_groups.html">Display Groups</a> — organise Displays into groups for easier management</li>
|
||||
<li><a href="displays_metrics.html">Reporting</a> — monitor Display activity and uptime</li>
|
||||
<li><a href="troubleshooting.html#display_connection_issues">Troubleshooting Display Connections</a> — resolve connection problems</li>
|
||||
</ul>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em><strong>What happens if I have no content scheduled, and my default layout has an issue with downloading it’s content?</strong></em></p>
|
||||
<p>The splash screen will be shown until the issue with the default layout is resolved or content is scheduled to show on the Display.</p>
|
||||
<p><em><strong>What does the Cloud Icon in the Status column of the Display Grid indicate?</strong></em></p>
|
||||
<p>The Cloud Icon shows that the Player has not logged in and content is waiting to be downloaded. A Cross indicates that the Player is yet to complete the download and a Tick shows the Player is up to date.</p>
|
||||
|
||||
</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>
|
||||
175
manual/en/displays_groups.html
Normal file
@@ -0,0 +1,175 @@
|
||||
<!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="displays">
|
||||
<!-- 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><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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<a href="displays.html">Displays</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_configuration.html">Display Configuration</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_settings.html">Display Settings</a>
|
||||
</li>
|
||||
<li class="active">
|
||||
<a href="displays_groups.html">Display Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_sync_groups.html">Sync Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_metrics.html">Reporting</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_command_functionality.html">Command Functionality</a>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<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="display_groups">Display Groups <a href="#display_groups" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Group together specific <strong>Displays</strong> to allow content and schedules to span multiple Displays with just one configured <strong>Event</strong>, saving time and reducing errors. Grouping Displays makes it easier to manage an expanding network. Simply add newly connected <strong>Displays</strong> to an existing <strong>Display Group</strong> to inherit schedules and to quickly start showing content.</p>
|
||||
<p>Group Displays by industry or location to make it easier to update and target content which differs by areas or purpose.</p>
|
||||
<p>Display Groups can contain a mix of singular <strong>Displays</strong> as well as other <strong>Display Groups</strong> to allow you to easily target the right Displays to show your content.</p>
|
||||
<p>For example, you could have Displays located within stores over different levels, intended to reach differing audiences so could have Display Groups that contain:</p>
|
||||
<ul>
|
||||
<li>All Displays in store A</li>
|
||||
<li>All Displays in store B</li>
|
||||
<li>All Displays that are street facing</li>
|
||||
<li>All Displays on level 1</li>
|
||||
<li>All Displays on level 2</li>
|
||||
<li>All internal Displays</li>
|
||||
<li>All external Displays</li>
|
||||
</ul>
|
||||
<p><strong>Create Display Groups</strong> and automatically assign <strong>Displays</strong> with matching criteria <strong>dynamically</strong> or <strong>manually</strong> selecting Display membership.</p>
|
||||
<ul>
|
||||
<li>Click on Add Display Group from the Display Groups grid.</li>
|
||||
</ul>
|
||||
<h2 id="dynamic_groups">Dynamic Groups <a href="#dynamic_groups" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>To assign members dynamically, tick the <strong>Dynamic Group</strong> checkbox.</p>
|
||||
<ul>
|
||||
<li>Set the <strong>filter criteria</strong> to use in the format of regular comma separated expressions or simple string comparisons.</li>
|
||||
<li>Prefix expressions with a <code>-</code> to exclude from filters. For example, all Displays containing <code>a</code> but not <code>b</code> in the name would be <code>a, -b</code>
|
||||
</li>
|
||||
<li>
|
||||
<strong>Criteria Tags</strong> can also be filtered using additional OR/AND filters for Displays with multiple Tags assigned.</li>
|
||||
</ul>
|
||||
<h2 id="manual_groups">Manual Groups <a href="#manual_groups" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>To assign members manually, leave the checkbox unticked and click to Save the form:</p>
|
||||
<ul>
|
||||
<li>Use the row menu for the new Display Group record and select <strong>Members</strong> using the checkbox for each Display.</li>
|
||||
</ul>
|
||||
<p>The Relationship Tree shows the ancestors and descendants. Parent Display Groups, shown above the selected Group will pass their schedule down to the Displays groups underneath.</p>
|
||||
<h2 id="nested_groups">Nested Groups <a href="#nested_groups" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Display Groups can be nested to simplify scheduling to allow sub-groups to inherit permissions from a parent group.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="displays_configuration.html">Configuring Displays</a></p>
|
||||
<p><a href="displays_sync_groups.html">Sync Groups</a></p>
|
||||
<p><a href="displays_settings.html">Display Profile Settings</a></p>
|
||||
<h2 id="see_also">See Also <a href="#see_also" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<ul>
|
||||
<li><a href="scheduling_events.html">Scheduling Events</a> — schedule content to Display Groups</li>
|
||||
<li><a href="displays.html">Displays</a> — connect and authorise individual Displays</li>
|
||||
<li><a href="configure_tags.html">Tags</a> — use Tags to build dynamic Display Group criteria</li>
|
||||
</ul>
|
||||
|
||||
</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>
|
||||
146
manual/en/displays_metrics.html
Normal file
@@ -0,0 +1,146 @@
|
||||
<!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="displays">
|
||||
<!-- 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><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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<a href="displays.html">Displays</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_configuration.html">Display Configuration</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_settings.html">Display Settings</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_groups.html">Display Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_sync_groups.html">Sync Groups</a>
|
||||
</li>
|
||||
<li class="active">
|
||||
<a href="displays_metrics.html">Reporting</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_command_functionality.html">Command Functionality</a>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<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="reporting">Reporting <a href="#reporting" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>OTS Signs Command Center has a variety of reports to help users assess network health and uptime and Display statistics. Proof of Play data offers further insights into content performance shown across your Display network to reveal trends to enable stakeholders to refine <a href="scheduling_events.html">content scheduling</a> and placement for improved targeting and audience engagement.</p>
|
||||
<p>Reports can be viewed in real time, emailed as a PDF to users and saved for future reference as well as scheduled to run on a Daily, Weekly, Monthly or Yearly basis.</p>
|
||||
<p>Available metrics can be found by selecting <strong>All Reports</strong> under the <strong>Reporting</strong> section of the main CMS menu.</p>
|
||||
<p>Similar Reports are grouped together to make it easier to find the data you need, which are presented as Charts as well as Tabular data so you can easily identify patterns and trends.</p>
|
||||
<h2 id="see_also">See Also <a href="#see_also" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<ul>
|
||||
<li><a href="displays.html">Displays</a> — manage and monitor your Display network</li>
|
||||
<li><a href="scheduling_events.html">Scheduling</a> — schedule content to Displays</li>
|
||||
<li><a href="configure_cms_settings.html">CMS Settings</a> — configure reporting defaults in CMS settings</li>
|
||||
</ul>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em><strong>Can I remove the logo shown on exported reports?</strong></em></p>
|
||||
<p>Go to Settings under the Administration section of the main CMS menu and select the General tab to control whether the logo should be shown.</p>
|
||||
<p><em><strong>Can I set a collection of proof of play stats by default for Displays?</strong></em></p>
|
||||
<p>From Settings under the Administration section of the main CMS menu, select Displays to enable Stats/Layout Stat Collection and Aggregation Level default for Displays.</p>
|
||||
|
||||
</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>
|
||||
144
manual/en/displays_settings.html
Normal file
@@ -0,0 +1,144 @@
|
||||
<!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="displays">
|
||||
<!-- 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><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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<a href="displays.html">Displays</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_configuration.html">Display Configuration</a>
|
||||
</li>
|
||||
<li class="active">
|
||||
<a href="displays_settings.html">Display Settings</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_groups.html">Display Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_sync_groups.html">Sync Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_metrics.html">Reporting</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_command_functionality.html">Command Functionality</a>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<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="display_settings">Display Settings <a href="#display_settings" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Each Display has settings which can be configured individually. Settings can vary depending on the platform/media player type, using <strong>Display Setting Profiles</strong> you can easily apply different settings to <strong>Displays</strong> of the same platform or type.</p>
|
||||
<p>Once connected to the CMS, each <strong>Display</strong> is assigned a default <strong>Display Profile</strong> to apply settings to Displays of the corresponding type.</p>
|
||||
<p>Profiles can be customised or new ones added to suit Display requirements. For ease use the row menu and <strong>Copy</strong> an existing <strong>Profile</strong> to quickly create new Profiles with the required settings.</p>
|
||||
<p>Use Display Profiles to provide your <strong>Licence Pool Code</strong> to all of your Displays centrally for easier licensing which is less prone to error than entering codes manually per device.</p>
|
||||
<p>Create Display Profiles to cater for Landscape and Portrait <strong>orientations</strong> or to apply different <strong>operating hours</strong> or a Display Profile for devices that require <strong>multiple decoders</strong> enabled for example.</p>
|
||||
<p>If individual Displays require different settings from those set in a Display Profile, override settings by editing the Display from the Displays grid.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="displays_configuration">Configure Displays</a></p>
|
||||
<p><a href="scheduling_dayparting">Define Operating Hours using Dayparts</a></p>
|
||||
<p><a href="displays_groups">Using Display Groups</a></p>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em><strong>I have a Display that should use an alternative Profile from the set default?</strong></em></p>
|
||||
<p>Override individual Displays from the Displays grid. Click to Edit and use the Settings tab to select an alternative Settings Profile to use for the selected Display.</p>
|
||||
|
||||
</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>
|
||||
165
manual/en/displays_sync_groups.html
Normal file
@@ -0,0 +1,165 @@
|
||||
<!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="displays">
|
||||
<!-- 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><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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<a href="displays.html">Displays</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_configuration.html">Display Configuration</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_settings.html">Display Settings</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_groups.html">Display Groups</a>
|
||||
</li>
|
||||
<li class="active">
|
||||
<a href="displays_sync_groups.html">Sync Groups</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_metrics.html">Reporting</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="displays_command_functionality.html">Command Functionality</a>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<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="sync_groups">Sync Groups <a href="#sync_groups" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Sync Groups contain the Displays that will show synchronised content. Content can be synchronised to play across 2 or more Displays in a mirrored or video wall configuration when scheduling a <a href="scheduling_events.html#content-synchronised-events">Synchronised Event</a>.</p>
|
||||
<blockquote class="tip"><p>Sync Playlists on different Layouts using the <strong>Content Synchronisation Key</strong>.</p>
|
||||
</blockquote>
|
||||
<p><a href="displays.html">Displays</a> first need to be assigned to a <strong>Sync Group</strong>:</p>
|
||||
<ul>
|
||||
<li>Click on <strong>Sync Groups</strong> under the <strong>Displays</strong> section of the main CMS menu.</li>
|
||||
<li>Select the <strong>Add Sync Group</strong> button.</li>
|
||||
</ul>
|
||||
<p><img src="img/v4_displays_add_sync_groups.png" alt="Add Sync Group" /></p>
|
||||
<p>Sync Groups can be saved to Folders to easily control User/User Group levels of interaction for Displays as well as provide an additional way to organise.</p>
|
||||
<blockquote class="tip"><p>All Displays in a Sync Group need to communicate using their LAN IP address over TCP on the publisher port specified. This is defaulted to 9590 but can be changed if that port is reserved.</p>
|
||||
<p>We recommend using a wired network and high-powered similar devices for the best Synchronisation.</p>
|
||||
</blockquote>
|
||||
<ul>
|
||||
<li>
|
||||
<p>On saving use the <strong>Manage Membership</strong> form to select which Displays to include in this Group.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>On saving use the Edit form use the drop down to select which Display should be the <strong>Lead Display</strong> for the Sync Group.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click to <strong>Save</strong></p>
|
||||
</li>
|
||||
</ul>
|
||||
<blockquote class="tip"><p>Content can now be scheduled to the Sync Group by clicking <strong>Schedule</strong> from the main CMS menu and selecting the <a href="scheduling_events.html#content-synchronised-events">Add Synchronised Event button</a>.</p>
|
||||
</blockquote>
|
||||
<h2 id="edit_/_manage_membership">Edit / Manage Membership <a href="#edit_/_manage_membership" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Manage a Sync Group by using the row menu:</p>
|
||||
<ul>
|
||||
<li>Select <strong>Edit</strong> to set an alternative Lead Display</li>
|
||||
<li>Select <strong>Members</strong> to manage which Displays are members of the group.</li>
|
||||
</ul>
|
||||
<h4>Next…</h4>
|
||||
<p><a href="scheduling_events.html#content-synchronised-events">Scheduling Synchronised Events</a></p>
|
||||
|
||||
</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>
|
||||
34
manual/en/extract_endings.py
Normal file
@@ -0,0 +1,34 @@
|
||||
import os
|
||||
|
||||
files = [
|
||||
'displays_settings.html', 'displays_sync_groups.html', 'displays_command_functionality.html',
|
||||
'scheduling_events.html', 'scheduling_overlays.html', 'scheduling_repeats.html',
|
||||
'scheduling_dayparting.html', 'scheduling_geolocation.html', 'scheduling_layout_list.html',
|
||||
'scheduling_ad_campaigns.html', 'scheduling_priority_display_order.html',
|
||||
'layouts_editor.html', 'layouts_editor_data_widgets.html', 'layouts_editor_design_changes.html',
|
||||
'layouts_editor_editing_tools.html', 'layouts_editor_global_elements.html',
|
||||
'layouts_editor_library_search.html', 'layouts_editor_playlists.html',
|
||||
'layouts_editor_using_templates.html', 'layouts_editor_widgets.html',
|
||||
'layouts_interactive_actions.html', 'layouts_templates.html',
|
||||
'media_library.html', 'media_playlists.html', 'media_datasets.html', 'media_menuboards.html',
|
||||
'media_modules.html', 'media_modules_connectors.html', 'media_dashboard_service.html',
|
||||
'media_resizing_images.html',
|
||||
'users_administration.html', 'users_groups.html',
|
||||
'configure_cms_settings.html', 'configure_folders.html', 'configure_tags.html',
|
||||
'configure_transitions.html',
|
||||
'troubleshooting.html', 'contact_support.html',
|
||||
]
|
||||
|
||||
marker = ' </div>\n </div>\n </div>'
|
||||
|
||||
for fn in files:
|
||||
with open(fn) as f:
|
||||
content = f.read()
|
||||
idx = content.rfind(marker)
|
||||
if idx == -1:
|
||||
print(f'=== {fn} === [marker not found]')
|
||||
continue
|
||||
snippet = content[max(0, idx-400):idx]
|
||||
print(f'=== {fn} ===')
|
||||
print(snippet[-350:])
|
||||
print()
|
||||
172
manual/en/getting_started_showing_a_playlist.html
Normal file
@@ -0,0 +1,172 @@
|
||||
<!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="getting_started">
|
||||
<!-- 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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<p><a href="index.html">Introduction</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_showing_an_image.html">Show an Image</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_showing_a_video.html">Show a Video</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p class="active"><a href="getting_started_showing_a_playlist.html">Show a Playlist</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_sorting_and_filtering.html">Sort and Filter Grids</a></p>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<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><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="showing_a_playlist_on_displays">Showing a Playlist on Displays <a href="#showing_a_playlist_on_displays" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p><strong>Create</strong> a <strong>Playlist</strong> of content and <strong>Schedule</strong> to show on <strong>Displays</strong>.</p>
|
||||
<p>You may have a set of content collated to meet a specific requirement which need to be shown in a rotating sequence on Displays. Playlists allow users to streamline resources and organise multiple content types to play in the order they need to be displayed.</p>
|
||||
<p>Playlists can have content added by automatic assignment based on selected criteria or by manual selection. For this example Image content already uploaded to the CMS Media Library will be added to a Playlist manually.</p>
|
||||
<h2 id="add_playlist">Add Playlist <a href="#add_playlist" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<ul>
|
||||
<li>Click on <strong>Playlists</strong> under the <strong>Library</strong> section of the main CMS menu.</li>
|
||||
<li>Click the <strong>Add Playlist</strong> button.</li>
|
||||
<li>Provide a <strong>Name</strong> for easy identification in the CMS.</li>
|
||||
<li>Click Save and the <strong>Playlist Editor</strong> will open.</li>
|
||||
</ul>
|
||||
<h2 id="adding_content">Adding Content <a href="#adding_content" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<ul>
|
||||
<li>Using the Toolbox, click on <strong>Library image search</strong> to add Images from the CMS Library.</li>
|
||||
<li>Use the filters to locate the <strong>Images</strong> to add.</li>
|
||||
<li>Drag and drop images to add to the <strong>Timeline</strong>.</li>
|
||||
<li>Re-order the sequence by drag and drop.</li>
|
||||
</ul>
|
||||
<p>You can view the total duration of the Playlist at the top of the Timeline.</p>
|
||||
<ul>
|
||||
<li>To change the duration of items in the Playlist, click to highlight and select the <strong>Advanced</strong> tab in the <strong>Properties Panel</strong>.</li>
|
||||
<li>Tick the <strong>Set a duration</strong> box and provide a new duration in seconds.</li>
|
||||
<li>Click the <strong>Save</strong> button to update the total duration of the Timeline.</li>
|
||||
<li>Select <strong>Exit</strong> to return to the Playlists grid.</li>
|
||||
</ul>
|
||||
<h2 id="select_playlist">Select Playlist <a href="#select_playlist" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<ul>
|
||||
<li>From the Playlists grid use the filters to locate the Playlist.</li>
|
||||
<li>Use the row menu and select <strong>Schedule</strong>.</li>
|
||||
<li>Select which <strong>Displays</strong> to show the Playlist on.</li>
|
||||
<li>If you want to use the default <strong>Always</strong> schedule, and happy with the default settings and have no further advanced scheduling options to set, you can click <strong>Finish</strong> to complete the schedule.</li>
|
||||
<li>If you want to select alternative created <strong>Dayparts</strong> or <strong>Custom</strong> dates, select <strong>Next</strong>.</li>
|
||||
<li>If you don’t need to apply any further scheduling options and are happy with the defaults set for <strong>Resolution</strong>, <strong>Background Colour</strong> etc. click to <strong>Finish</strong>.</li>
|
||||
</ul>
|
||||
<p>The CMS will now update a Schedule change and the Playlist will be shown on Displays for the timings set in the schedule.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="getting_started_showing_an_image.html">Show a full screen Image on Displays</a></p>
|
||||
<p><a href="getting_started_showing_a_video.html">Show a full screen Video on Displays</a></p>
|
||||
<p><a href="layouts_editor.html">Use the Layout Editor to create your own content</a></p>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em><strong>I don’t see the wizard when scheduling a Playlist?</strong></em></p>
|
||||
<p>A wizard was introduced in v4.4 to simplify the scheduling process. Use the link to view the earlier flow: <a href="getting_started_showing_a_playlist_v4.html">Showing a Playlist</a></p>
|
||||
<p><em><strong>Can I add Widgets to a Playlist?</strong></em></p>
|
||||
<p>Yes, Widgets can be added using the Playlist Editor using the top button from the Toolbox.</p>
|
||||
<p><em><strong>I don’t see any Global or Data Elements to add to my Playlist?</strong></em></p>
|
||||
<p>Elements are not available in the Playlist Editor. Data Widgets have a selection of Static Templates to choose from to display your data.</p>
|
||||
<p><em><strong>Do I have to upload the files I want to use to the CMS Media Library before creating a Playlist?</strong></em></p>
|
||||
<p>No, you can upload media directly to a Playlist by dragging the Upload card for a selected media type to the Timeline and use the file uploader.</p>
|
||||
|
||||
</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>
|
||||
170
manual/en/getting_started_showing_a_playlist_v4.html
Normal file
@@ -0,0 +1,170 @@
|
||||
<!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="">
|
||||
<!-- 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><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="showing_a_playlist_on_displays">Showing a Playlist on Displays <a href="#showing_a_playlist_on_displays" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p><strong>Create</strong> a <strong>Playlist</strong> of content and <strong>Schedule</strong> to show on <strong>Displays</strong>.</p>
|
||||
<p>You may have a set of content collated to meet a specific requirement which need to be shown in a rotating sequence on Displays. Playlists allow users to streamline resources and organise multiple content types to play in the order they need to be displayed.</p>
|
||||
<p>Playlists can have content added by automatic assignment based on selected criteria or by manual selection. For this example Image content already uploaded to the CMS Media Library will be added to a Playlist manually.</p>
|
||||
<h2 id="add_playlist">Add Playlist <a href="#add_playlist" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<ul>
|
||||
<li>Click on <strong>Playlists</strong> under the <strong>Library</strong> section of the main CMS menu.</li>
|
||||
<li>Click the <strong>Add Playlist</strong> button.</li>
|
||||
<li>Provide a <strong>Name</strong> for easy identification in the CMS.</li>
|
||||
<li>Click Save and the <strong>Playlist Editor</strong> will open.</li>
|
||||
</ul>
|
||||
<h2 id="adding_content">Adding Content <a href="#adding_content" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<ul>
|
||||
<li>Using the Toolbox, click on <strong>Library image search</strong> to add Images from the CMS Library.</li>
|
||||
<li>Use the filters to locate the <strong>Images</strong> to add.</li>
|
||||
<li>Drag and drop images to add to the <strong>Timeline</strong>.</li>
|
||||
<li>Re-order the sequence by drag and drop.</li>
|
||||
</ul>
|
||||
<p>You can view the total duration of the Playlist at the top of the Timeline.</p>
|
||||
<ul>
|
||||
<li>To change the duration of items in the Playlist, click to highlight and select the <strong>Advanced</strong> tab in the <strong>Properties Panel</strong>.</li>
|
||||
<li>Tick the <strong>Set a duration</strong> box and provide a new duration in seconds.</li>
|
||||
<li>Click the <strong>Save</strong> button to update the total duration of the Timeline.</li>
|
||||
<li>Select <strong>Exit</strong> to return to the Playlists grid.</li>
|
||||
</ul>
|
||||
<h2 id="select_playlist">Select Playlist <a href="#select_playlist" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<ul>
|
||||
<li>
|
||||
<p>From the Playlists grid use the filters to locate the Playlist.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Use the row menu and select <strong>Schedule</strong>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>The <strong>Select Playlist</strong> form will open to provide further configuration options for the Playlist:</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Select a specific <strong>Resolution</strong> to use.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Set a <strong>colour</strong> to fill any gaps in the background if the Playlist content will not fill the screen.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Save</strong> to close the <strong>Select Playlist</strong> form and continue with scheduling.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h2 id="schedule_event">Schedule Event <a href="#schedule_event" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p>Complete the fields in the <strong>Schedule Event</strong> form:</p>
|
||||
<ul>
|
||||
<li>Give the event a <strong>Name</strong> for easier identification in the CMS.</li>
|
||||
<li>Select which <strong>Displays</strong> this Playlist will be shown on.</li>
|
||||
<li>From <strong>Dayparting</strong>, select <strong>Custom</strong> to set specific start and end dates/times or select <strong>Always</strong> to show the Playlist constantly.</li>
|
||||
<li>Click <strong>Save.</strong>
|
||||
</li>
|
||||
</ul>
|
||||
<p>The CMS will now update a Schedule change and the Playlist will be shown on Displays for the timings set in the schedule.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="layouts_editor.html">Use the Layout Editor to create your own content</a></p>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em><strong>Can I add Widgets to a Playlist?</strong></em></p>
|
||||
<p>Yes, Widgets can be added using the Playlist Editor using the top button from the Toolbox.</p>
|
||||
<p><em><strong>I don’t see any Global or Data Elements to add to my Playlist?</strong></em></p>
|
||||
<p>Elements are not available in the Playlist Editor. Data Widgets have a selection of Static Templates to choose from to display your data.</p>
|
||||
<p><em><strong>Do I have to upload the files I want to use to the CMS Media Library before creating a Playlist?</strong></em></p>
|
||||
<p>No, you can upload media directly to a Playlist by dragging the Upload card for a selected media type to the Timeline and use the file uploader.</p>
|
||||
|
||||
</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>
|
||||
193
manual/en/getting_started_showing_a_video.html
Normal file
@@ -0,0 +1,193 @@
|
||||
<!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="getting_started">
|
||||
<!-- 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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<p><a href="index.html">Introduction</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_showing_an_image.html">Show an Image</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p class="active"><a href="getting_started_showing_a_video.html">Show a Video</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_showing_a_playlist.html">Show a Playlist</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_sorting_and_filtering.html">Sort and Filter Grids</a></p>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<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><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="showing_a_video_on_displays">Showing a Video on Displays <a href="#showing_a_video_on_displays" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Add a <strong>Video</strong> file to your <strong>Media Library</strong> and <strong>Schedule</strong> to play on <strong>Displays</strong>.</p>
|
||||
<p>You may have Video content which has been created to showcase product promotions or show company updates to employees, ready to be shown full screen on your Display network.</p>
|
||||
<p>Video files are first added to the Library by upload or by URL. For this example a Video file will be uploaded to the CMS Media Library.</p>
|
||||
<h3>Add Media</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Click on <strong>Media</strong> under the <strong>Library</strong> section of the main CMS menu.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click the <strong>Add Media</strong> button.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Select <strong>Add files</strong> and select the Video file to upload.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Use the scroll bar to select a frame to use as the Video thumbnail, to make it easier to identify in Media Library lists.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Provide a new <strong>Name</strong> or leave this field blank to keep the original file name.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click <strong>Start upload</strong>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Once uploaded click <strong>Done</strong>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Select Media</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<p>From the <strong>Media</strong> grid use the filters to make it easier to find the uploaded video file if required.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Use the row menu and select <strong>Schedule</strong>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Select which <strong>Displays</strong> to show the video on.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>If you want to use the default <strong>Always</strong> schedule, and happy with the default settings and have no further scheduling options to set, you can click <strong>Finish</strong> to complete the schedule.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>If you want to select alternative created <strong>Dayparts</strong> or <strong>Custom</strong> dates, select <strong>Next</strong>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>To configure advanced scheduling options and override the duration of the video for example, click <strong>Next</strong>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p><strong>Duration in loop</strong> determines how long this video should be shown each time it appears in a <strong>Schedule Loop</strong>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>You can specify a <strong>duration</strong> here and provide a lower duration to cut the video short. When setting a higher duration, the video will loop back to the beginning and play to satisfy the duration applied.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click to <strong>Finish</strong> once all relevant fields have been completed.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>The CMS will now update a Schedule change and your Video will be shown on Displays for the timings set in the schedule.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="getting_started_showing_a_playlist.html">Use Playlists to show a carousal/slideshow of images</a></p>
|
||||
<p><a href="layouts_editor.html">Use the Layout Editor to create your own content</a></p>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em><strong>I don’t see the wizard when scheduling a Video?</strong></em></p>
|
||||
<p>A wizard was introduced in v4.4 to simplify the scheduling process. Use the link to view the earlier flow: <a href="getting_started_showing_a_video_v4.html">Showing a Video</a></p>
|
||||
<p><em><strong>What are Schedule Loops?</strong></em></p>
|
||||
<p>A Schedule Loop is how media content will play when in schedules with other media content. For example, if you have scheduled 2 media items each with a 10 second duration to be shown at the same time for 1 hour, both items will play for their 10 second durations in fair rotation for the scheduled time.</p>
|
||||
<p><em><strong>Which file format is recommended for Videos?</strong></em></p>
|
||||
<p>We recommend H264 MP4 file format.</p>
|
||||
|
||||
</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>
|
||||
164
manual/en/getting_started_showing_a_video_v4.html
Normal file
@@ -0,0 +1,164 @@
|
||||
<!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="">
|
||||
<!-- 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><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="showing_a_video_on_displays">Showing a Video on Displays <a href="#showing_a_video_on_displays" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Add a <strong>Video</strong> file to your <strong>Media Library</strong> and <strong>Schedule</strong> to play on <strong>Displays</strong>.</p>
|
||||
<p>You may have Video content which has been created to showcase product promotions or show company updates to employees, ready to be shown full screen on your Display network.</p>
|
||||
<p>Video files are first added to the Library by upload or by URL. For this example a Video file will be uploaded to the CMS Media Library.</p>
|
||||
<h3>Add Media</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Click on <strong>Media</strong> under the <strong>Library</strong> section of the main CMS menu.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click the <strong>Add Media</strong> button.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Select <strong>Add files</strong> and select the Video file to upload.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Use the scroll bar to select a frame to use as the Video thumbnail, to make it easier to identify in Media Library lists.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Provide a new <strong>Name</strong> or leave this field blank to keep the original file name.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click <strong>Start upload</strong>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Once uploaded click <strong>Done</strong>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Select Media</h3>
|
||||
<ul>
|
||||
<li>From the <strong>Media</strong> grid use the filters to make it easier to find the uploaded video file if required.</li>
|
||||
<li>Use the row menu and select <strong>Schedule</strong>:</li>
|
||||
</ul>
|
||||
<p>The <strong>Select Media</strong> form will open to provide further configuration options for the Video:</p>
|
||||
<p><strong>Duration in loop</strong> determines how long the video should play each time it appears in a <strong>Schedule Loop</strong>.</p>
|
||||
<ul>
|
||||
<li>Set a lower duration to cut the original file short or set a higher duration and the video will “loop” back to the beginning to satisfy a longer set duration.</li>
|
||||
<li>Select a a specific <strong>Resolution</strong> to use.</li>
|
||||
<li>Set a <strong>colour</strong> to fill any gaps in the background if the media file will not fill the screen.</li>
|
||||
<li>
|
||||
<strong>Save</strong> to close the <strong>Select Media</strong> form and continue with scheduling.</li>
|
||||
</ul>
|
||||
<h3>Schedule Event</h3>
|
||||
<p>Complete the fields in the <strong>Schedule Event</strong> form:</p>
|
||||
<ul>
|
||||
<li>Give the event a <strong>Name</strong> for easier identification in the CMS.</li>
|
||||
<li>Select which <strong>Displays</strong> this Video will be shown on.</li>
|
||||
<li>From <strong>Dayparting</strong>, select <strong>Always</strong> to show the Video constantly or select <strong>Custom</strong> to set specific start and end dates/times.</li>
|
||||
<li>Click <strong>Save.</strong>
|
||||
</li>
|
||||
</ul>
|
||||
<p>The CMS will now update a Schedule change and your Video will be shown on Displays for the timings set in the schedule.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="layouts_editor.html">Use the Layout Editor to create your own content</a></p>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em><strong>What are Schedule Loops?</strong></em></p>
|
||||
<p>A Schedule Loop is how media content will play when in schedules with other media content. For example, if you have scheduled 2 media items each with a 10 second duration to be shown at the same time for 1 hour, both items will play for their 10 second durations in fair rotation for the scheduled time.</p>
|
||||
<p><em><strong>Which file format is recommended for Videos?</strong></em></p>
|
||||
<p>We recommend H264 MP4 file format.</p>
|
||||
|
||||
</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>
|
||||
176
manual/en/getting_started_showing_an_image.html
Normal file
@@ -0,0 +1,176 @@
|
||||
<!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="getting_started">
|
||||
<!-- 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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<p><a href="index.html">Introduction</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p class="active"><a href="getting_started_showing_an_image.html">Show an Image</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_showing_a_video.html">Show a Video</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_showing_a_playlist.html">Show a Playlist</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_sorting_and_filtering.html">Sort and Filter Grids</a></p>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<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><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="showing_an_image_on_displays">Showing an Image on Displays <a href="#showing_an_image_on_displays" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Add an <strong>Image</strong> file to your <strong>Media Library</strong> and <strong>Schedule</strong> to play on <strong>Displays</strong>.</p>
|
||||
<p>You may have image content created outside of the Layout Editor, e.g. created by an agency, in house marketing team etc, ready to be shown full screen on your Display network.</p>
|
||||
<p>Image files are first added to the Library by upload or by URL. For this example an Image file will be uploaded to the CMS Media Library.</p>
|
||||
<h3>Add Media</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Click on <strong>Media</strong> under the <strong>Library</strong> section of the main CMS menu.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click the <strong>Add Media</strong> button.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Select <strong>Add files</strong> and select the Image file to upload.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Provide a new <strong>Name</strong> or leave this field blank to keep the original file name.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click <strong>Start upload</strong>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Once uploaded click <strong>Done</strong>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Select Media</h3>
|
||||
<ul>
|
||||
<li>From the <strong>Media</strong> grid use the filters to make it easier to find the uploaded <strong>Image</strong> file if required.</li>
|
||||
<li>Use the row menu and select <strong>Schedule</strong>:</li>
|
||||
</ul>
|
||||
<p><img src="img/v4_showing_images_videos_row_menu_schedule.png" alt="Media Row Menu Schedule" /></p>
|
||||
<ul>
|
||||
<li>Select which <strong>Displays</strong> to show the Image on.</li>
|
||||
<li>If you want to use the default <strong>Always</strong> schedule, and happy with the default settings and have no further advanced scheduling options to set, you can click <strong>Finish</strong> to complete the schedule.</li>
|
||||
<li>If you want to select alternative created <strong>Dayparts</strong> or <strong>Custom</strong> dates, select <strong>Next</strong>.</li>
|
||||
<li>If you don’t need to apply any further scheduling options and are happy with the defaults set for <strong>Duration in Loop</strong>, <strong>Resolution</strong> etc, click to <strong>Finish</strong>.</li>
|
||||
</ul>
|
||||
<blockquote class="tip"><p><strong>Duration in loop</strong> determines how long this Image should be shown each time it appears in a <strong>Schedule Loop</strong>.</p>
|
||||
</blockquote>
|
||||
<p>The CMS will now update a Schedule change and the Image will be shown on Displays for the timings set in the schedule.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="getting_started_showing_a_playlist.html">Use Playlists to show a carousal/slideshow of images</a></p>
|
||||
<p><a href="layouts_editor.html">Use the Layout Editor to create your own content</a></p>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em><strong>I don’t see the wizard when scheduling an Image?</strong></em></p>
|
||||
<p>A wizard was introduced in v4.4 to simplify the scheduling process. Use the link to view the earlier flow: <a href="getting_started_showing_an_image_v4.html">Showing an Image</a></p>
|
||||
<p><em><strong>What are Schedule Loops?</strong></em></p>
|
||||
<p>A Schedule Loop is how media content will play when in schedules with other media content. For example, if you have scheduled 2 media items each with a 10 second duration to be shown at the same time for 1 hour, both items will play for their 10 second durations in fair rotation for the scheduled time.</p>
|
||||
<p><em><strong>What file extensions are supported on upload?</strong></em></p>
|
||||
<p>Valid file extensions: jpg,jpeg,png,bmp,gif,webp.</p>
|
||||
<p><em><strong>Can I upload an animated gif?</strong></em></p>
|
||||
<p>Animated gif’s are not supported.</p>
|
||||
|
||||
</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>
|
||||
171
manual/en/getting_started_showing_an_image_v4.html
Normal file
@@ -0,0 +1,171 @@
|
||||
<!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="">
|
||||
<!-- 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><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="showing_an_image_on_displays">Showing an Image on Displays <a href="#showing_an_image_on_displays" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Add an <strong>Image</strong> file to your <strong>Media Library</strong> and <strong>Schedule</strong> to play on <strong>Displays</strong>.</p>
|
||||
<p>You may have image content created outside of the Layout Editor, e.g. created by an agency, in house marketing team etc, ready to be shown full screen on your Display network.</p>
|
||||
<p>Image files are first added to the Library by upload or by URL. For this example an Image file will be uploaded to the CMS Media Library.</p>
|
||||
<h3>Add Media</h3>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Click on <strong>Media</strong> under the <strong>Library</strong> section of the main CMS menu.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click the <strong>Add Media</strong> button.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Select <strong>Add files</strong> and select the Image file to upload.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Provide a new <strong>Name</strong> or leave this field blank to keep the original file name.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click <strong>Start upload</strong>.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Once uploaded click <strong>Done</strong>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Select Media</h3>
|
||||
<ul>
|
||||
<li>From the <strong>Media</strong> grid use the filters to make it easier to find the uploaded <strong>Image</strong> file if required.</li>
|
||||
<li>Use the row menu and select <strong>Schedule</strong>:</li>
|
||||
</ul>
|
||||
<p><img src="img/v4_showing_images_videos_row_menu_schedule.png" alt="Media Row Menu Schedule" /></p>
|
||||
<p>The <strong>Select Media</strong> form will open to provide further configuration options for the Image:</p>
|
||||
<p><strong>Duration in loop</strong> determines how long this Image should be shown each time it appears in a <strong>Schedule Loop</strong>.</p>
|
||||
<ul>
|
||||
<li>Specify a <strong>duration</strong> to override the Image file duration.</li>
|
||||
<li>Select a a specific <strong>Resolution</strong> to use.</li>
|
||||
<li>Set a <strong>colour</strong> to fill any gaps in the background if the Image will not fill the screen.</li>
|
||||
<li>
|
||||
<strong>Save</strong> to close the <strong>Select Media</strong> form and continue with scheduling.</li>
|
||||
</ul>
|
||||
<h3>Schedule Event</h3>
|
||||
<p>Complete the fields in the <strong>Schedule Event</strong> form:</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Give the event a <strong>Name</strong> for easier identification in the CMS.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Select which <strong>Displays</strong> this Image will be shown on.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>From <strong>Dayparting</strong>, select <strong>Custom</strong> to set specific start and end dates/times or choose <strong>Always</strong> to show the Image on Displays constantly.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Click <strong>Save.</strong></p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>The CMS will now update a Schedule change and the Image will be shown on Displays for the timings set in the schedule.</p>
|
||||
<h2 id="further_reading">Further Reading <a href="#further_reading" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><a href="layouts_editor.html">Use the Layout Editor to create your own content</a></p>
|
||||
<h2 id="faqs">FAQs <a href="#faqs" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h2>
|
||||
<p><em><strong>What are Schedule Loops?</strong></em></p>
|
||||
<p>A Schedule Loop is how media content will play when in schedules with other media content. For example, if you have scheduled 2 media items each with a 10 second duration to be shown at the same time for 1 hour, both items will play for their 10 second durations in fair rotation for the scheduled time.</p>
|
||||
<p><em><strong>What file extensions are supported on upload?</strong></em></p>
|
||||
<p>Valid file extensions: jpg,jpeg,png,bmp,gif,webp.</p>
|
||||
<p><em><strong>Can I upload an animated gif?</strong></em></p>
|
||||
<p>Animated gif’s are not supported.</p>
|
||||
|
||||
</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>
|
||||
143
manual/en/getting_started_sorting_and_filtering.html
Normal file
@@ -0,0 +1,143 @@
|
||||
<!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="getting_started">
|
||||
<!-- 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><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
|
||||
<html><body><ul>
|
||||
<li>
|
||||
<p><a href="index.html">Introduction</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_showing_an_image.html">Show an Image</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_showing_a_video.html">Show a Video</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p><a href="getting_started_showing_a_playlist.html">Show a Playlist</a></p>
|
||||
</li>
|
||||
<li>
|
||||
<p class="active"><a href="getting_started_sorting_and_filtering.html">Sort and Filter Grids</a></p>
|
||||
</li>
|
||||
</ul>
|
||||
</body></html>
|
||||
<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><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="sorting_and_filtering">Sorting and Filtering <a href="#sorting_and_filtering" class="header-link"><span class="glyphicon glyphicon-link"></span></a></h1>
|
||||
<p>Page information within the CMS is presented as tabular data in a grid format. <strong>Grids</strong> have a number of features that when combined create a flexible tool for Users making it easier to visualize and understand presented information.</p>
|
||||
<p>Multiple filter fields can be used to restrict criteria for returned results.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>Use the checkbox to apply advanced filtering options for Names using Regex and provide AND/OR criteria using comma separated terms.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>The <strong>Advanced</strong> tab provides access to further filtering options for pages.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>Results are populated into columns, which can be sorted by clicking on the column header or by using the Shift key to sort multiple columns that contain up/down arrows.</p>
|
||||
<ul>
|
||||
<li>Hold shift and click on the column headings to sort in the order selected.</li>
|
||||
</ul>
|
||||
<p>The <strong>Column Visibility</strong> button is used to select/de-select which columns are needed in the data table, making it an extremely useful tool for Users to customise which columns should be visible for each grid.</p>
|
||||
<p>If the number of columns selected can not fit to your screen size, the information will be hidden as additional rows, indicated by a + icon at the beginning of the row. Clicking on this icon will show the hidden information.</p>
|
||||
<p>At the bottom of selected grids, a <strong>With Selected</strong> option is available for users to multi-select rows in order to easily perform bulk actions, such as Deleting, Sharing and moving items to Folders.</p>
|
||||
<p>Use the row menu to access a set of actions for a selected item. Selected row menu actions across grids have an ‘auto submit’ capability. Once ticked the action will be automatically submitted without any further confirmation requirements when next selected.</p>
|
||||
|
||||
</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>
|
||||
BIN
manual/en/img/display_configuration_map_view_icon.png
Normal file
|
After Width: | Height: | Size: 4.3 KiB |
BIN
manual/en/img/how_to_create_a_layout.png
Normal file
|
After Width: | Height: | Size: 50 KiB |
BIN
manual/en/img/how_to_create_a_playlist.png
Normal file
|
After Width: | Height: | Size: 176 KiB |
BIN
manual/en/img/how_to_creating_user_groups.png
Normal file
|
After Width: | Height: | Size: 977 KiB |
BIN
manual/en/img/how_to_creating_users.png
Normal file
|
After Width: | Height: | Size: 1.3 MiB |
BIN
manual/en/img/how_to_design_changes.png
Normal file
|
After Width: | Height: | Size: 646 KiB |
BIN
manual/en/img/how_to_display_configuration.png
Normal file
|
After Width: | Height: | Size: 548 KiB |
BIN
manual/en/img/how_to_layout_list_campaign.png
Normal file
|
After Width: | Height: | Size: 440 KiB |
BIN
manual/en/img/how_to_managing_folders.png
Normal file
|
After Width: | Height: | Size: 369 KiB |
BIN
manual/en/img/how_to_managing_tags.png
Normal file
|
After Width: | Height: | Size: 564 KiB |
BIN
manual/en/img/how_to_show_a_video.png
Normal file
|
After Width: | Height: | Size: 876 KiB |
BIN
manual/en/img/how_to_show_an_image.png
Normal file
|
After Width: | Height: | Size: 542 KiB |
BIN
manual/en/img/how_to_simple_scheduling.png
Normal file
|
After Width: | Height: | Size: 70 KiB |
BIN
manual/en/img/how_to_simple_scheduling_4_4.png
Normal file
|
After Width: | Height: | Size: 1.0 MiB |
BIN
manual/en/img/how_to_sorting_and_filtering.png
Normal file
|
After Width: | Height: | Size: 1.2 MiB |
BIN
manual/en/img/how_to_use_global_elements.png
Normal file
|
After Width: | Height: | Size: 64 KiB |
BIN
manual/en/img/how_to_use_library_searches.png
Normal file
|
After Width: | Height: | Size: 208 KiB |
BIN
manual/en/img/how_to_using_editing_tools.png
Normal file
|
After Width: | Height: | Size: 386 KiB |
BIN
manual/en/img/how_to_using_repeats.png
Normal file
|
After Width: | Height: | Size: 1.0 MiB |
BIN
manual/en/img/how_to_using_templates.png
Normal file
|
After Width: | Height: | Size: 172 KiB |
BIN
manual/en/img/how_to_what_is_a_display.png
Normal file
|
After Width: | Height: | Size: 94 KiB |
BIN
manual/en/img/layout_editor_overview_explainer.png
Normal file
|
After Width: | Height: | Size: 79 KiB |
BIN
manual/en/img/layouts_toolbar_1.png
Normal file
|
After Width: | Height: | Size: 8.8 KiB |
BIN
manual/en/img/media_module_emergency_alerts_elements.png
Normal file
|
After Width: | Height: | Size: 84 KiB |
BIN
manual/en/img/media_module_national_weather_alerts_elements.png
Normal file
|
After Width: | Height: | Size: 95 KiB |
BIN
manual/en/img/report-fault-step1.png
Normal file
|
After Width: | Height: | Size: 34 KiB |
2
manual/en/img/test.png
Normal file
@@ -0,0 +1,2 @@
|
||||
‰PNG
|
||||
|
||||
|
After Width: | Height: | Size: 8 B |
BIN
manual/en/img/v4.1_layouts_add_layout.png
Normal file
|
After Width: | Height: | Size: 36 KiB |
BIN
manual/en/img/v4.1_layouts_editor_add_playlists.png
Normal file
|
After Width: | Height: | Size: 109 KiB |
BIN
manual/en/img/v4.1_layouts_editor_convert_playlist.png
Normal file
|
After Width: | Height: | Size: 188 KiB |
BIN
manual/en/img/v4.1_layouts_editor_playlist_cycle_playback.png
Normal file
|
After Width: | Height: | Size: 41 KiB |
BIN
manual/en/img/v4.1_layouts_editor_playlist_spots.png
Normal file
|
After Width: | Height: | Size: 110 KiB |
BIN
manual/en/img/v4.1_layouts_editor_playlists_preview_content.png
Normal file
|
After Width: | Height: | Size: 127 KiB |
BIN
manual/en/img/v4.1_layouts_editor_synchronisation_key.png
Normal file
|
After Width: | Height: | Size: 92 KiB |
BIN
manual/en/img/v4.1_layouts_layout_editor_overview.png
Normal file
|
After Width: | Height: | Size: 136 KiB |
BIN
manual/en/img/v4.1_media_playlists_embedding.png
Normal file
|
After Width: | Height: | Size: 146 KiB |
BIN
manual/en/img/v4.1_media_playlists_grid.png
Normal file
|
After Width: | Height: | Size: 39 KiB |
BIN
manual/en/img/v4_campaigns_ad_campaign_grid.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
manual/en/img/v4_campaigns_assign_layouts.png
Normal file
|
After Width: | Height: | Size: 23 KiB |
BIN
manual/en/img/v4_campaigns_assign_layouts_ad_campaign.png
Normal file
|
After Width: | Height: | Size: 684 KiB |
BIN
manual/en/img/v4_campaigns_edit_ad_campaign.png
Normal file
|
After Width: | Height: | Size: 44 KiB |
BIN
manual/en/img/v4_campaigns_edit_layout_list.png
Normal file
|
After Width: | Height: | Size: 29 KiB |
BIN
manual/en/img/v4_campaigns_view_added_ad_campaigns.png
Normal file
|
After Width: | Height: | Size: 84 KiB |
BIN
manual/en/img/v4_displays_add_sync_groups.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
manual/en/img/v4_displays_administration_display_map_status.png
Normal file
|
After Width: | Height: | Size: 728 KiB |
BIN
manual/en/img/v4_displays_administration_grid.png
Normal file
|
After Width: | Height: | Size: 40 KiB |
BIN
manual/en/img/v4_displays_administration_map_view.png
Normal file
|
After Width: | Height: | Size: 1.4 MiB |
BIN
manual/en/img/v4_displays_bandwidth.png
Normal file
|
After Width: | Height: | Size: 25 KiB |
BIN
manual/en/img/v4_displays_bandwidth_display.png
Normal file
|
After Width: | Height: | Size: 31 KiB |
BIN
manual/en/img/v4_displays_commands.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
manual/en/img/v4_displays_commands_add_command.png
Normal file
|
After Width: | Height: | Size: 18 KiB |
BIN
manual/en/img/v4_displays_edit_form.png
Normal file
|
After Width: | Height: | Size: 32 KiB |
BIN
manual/en/img/v4_displays_edit_profilesettings.png
Normal file
|
After Width: | Height: | Size: 60 KiB |
BIN
manual/en/img/v4_displays_group_dynamic.png
Normal file
|
After Width: | Height: | Size: 24 KiB |
BIN
manual/en/img/v4_displays_groups_add.png
Normal file
|
After Width: | Height: | Size: 18 KiB |
BIN
manual/en/img/v4_displays_groups_grid.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
manual/en/img/v4_displays_groups_memberships.png
Normal file
|
After Width: | Height: | Size: 23 KiB |
BIN
manual/en/img/v4_displays_manage_dashboard.png
Normal file
|
After Width: | Height: | Size: 63 KiB |
BIN
manual/en/img/v4_displays_move_cms.png
Normal file
|
After Width: | Height: | Size: 19 KiB |