Skip to content

Commit

Permalink
read me
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean committed Mar 24, 2015
1 parent cf41508 commit b6ecf61
Show file tree
Hide file tree
Showing 9 changed files with 124 additions and 6 deletions.
113 changes: 112 additions & 1 deletion README.md
@@ -1 +1,112 @@
...
DigitalSignage: Digg Component
===

open source digital signage HTML SDK
---

The component enables to load up the latest Digg.com posts.
Powered by bootstrap and using responsive design, the digg posts will be repositioned to automatically occupy the full width of the scene or screen division assigned.
Choose scroll speed and background color through the StudioPro properties page.
Also, the component (through the embedded HTML wrapper or Node web kit wrapper) takes advantage of local caching so it can continue and work offline with no interruption to your audience.

Anyone can modify this Digital Signage component that consists of both a SignagePlayer HTML / CSS / Javascript module as well as
StudioPro properties page HTML / CSS / Javascript module, for the free SignagePlayer from http://digitalsignage.com.

Player component:
----
- runtime Javascript component which resides and plays inside the SignagePlayer and is assigned into a screen division or scene
- the javascript component has full access to all SignagePlayer resources including swf, videos, images, svgs and data
- local caching of data and resources to support offline playback of the component
- choose between embedded HTML wrapper, native browser wrapper or Node Web kit wrapper (node only for Windows OS)
- full support for all Javascript libraries such as require.js, backbone, angular etc

Studio component:
----
- runtime Javascript component which resides and loads inside the free StudioPro and can be assigned into a screen division or scene
- the javascript component has full access to all StudioPro resources including swf, videos, images, svgs and data
- create a fully customizable properties page for your player component, powered by HTML / CSS / Javascript
- full support for all Javascript libraries such as require.js, backbone, angular etc

HTML Wrapper
----
Your custom Player component that runs inside the SignagePlayer can execute under 3 different modes, depending on the operating system and your settings.

1. Windows: choose between the SignagePlayer embedded HTML or Node-Web-Kit (node.js + Google Chromium)
2. Android: Use only the native default built in HTML browser on the underline Android device
3. Mac: HTML mode only

HTML wrapper comparison

HTML Pros:
1. built into SignagePlayer, no needed for external executable
2. support for all screen layering (masks)
3. runs on Windows and Mac
HTML Cons:
1. does not use the latest HTML5 rendering engine
2. slower performance
3. operates under standard HTML security box

Node web kit Pros:
1. super fast HTML rendering powered by latest Google Chromium release
2. full access to the host file system and devices (no security limitations)
3. most efficient memory management since runs as an external process
4. fully integrated into the SignagePlayer for windows (nw.exe), runs with no toolbar (clean window)
HTML Cons:
1. does not support layering (always on top)
2. only runs on SignagePlayer for windows
3. runs as an external application

Native browser Pros:
1. runs as fast (or as slow) as the default Android default browser
2. nothing special to install or configure
Native browser Cons:
1. runs as fast (or as slow) as the default Android default browser
2. does not support layering
3. operates under standard HTML security box

- Studio component: runtime Javascript module which lives inside the StudioPro as a properties and settings page

Configuration
-----
your_app_name.json includes the configuration used to setup your Studio and Player component.

```
{
"name": "your_app_name",
"version": "1.0.457",
"url": "http://signage.me/components/your_app_name/your_app_name.zip",
"property": "page.html",
"desktopUseNode": false,
"debug": false
}
```
- name: the name of your HTML / CSS / Javascript component

- version: used to force the SignagePlayer and StudioPro to re-download the latest revision of your developed component.

- url: points to a web url that hosts your zip file. The zip file consists of everything your component needs,
including Studio and Player components.

- property: the name of the file to load in StudioPro to display the properties page for the component

- desktopUseNode: true / false. When set to true, your component will run inside the wrapper of Node Web Kit in Windows.
if set to false, the component will run in the embedded HTML wrapper in Windows and Mac and use the native browser in Android.

- debug: when set to desktopUseNode: true, the debug mode allows for remote debugging of the Player component in windows
using node web kit.

Tutorial
-----
**For a full demonstration on how to build, deploy and use the open source SignagePlayer and StudioPro components be sure to view the following video tutorials:**

- [Development environment](http://www.digitalsignage.com/_html/video_tutorials.html?videoNumber=50)
- [HTML5 component development part1](http://www.digitalsignage.com/_html/video_tutorials.html?videoNumber=50)
- [HTML5 component development part2](http://www.digitalsignage.com/_html/video_tutorials.html?videoNumber=50)








4 changes: 2 additions & 2 deletions digg.json
@@ -1,8 +1,8 @@
{
"name": "digg",
"version": "1.0.485",
"version": "1.0.494",
"url": "http://signage.me/components/digg/digg.zip",
"property": "page.html",
"desktopUseNode": false,
"desktopUseNode": true,
"debug": false
}
Binary file modified digg.zip
Binary file not shown.
2 changes: 1 addition & 1 deletion js/templates/DiggArticle.html
@@ -1,6 +1,6 @@
<div class="brdr bgc-fff pad-10 box-shad btm-mrg-20 property-listing">
<div class="media">
<a class="pull-left" href="#" target="_parent">
<a class="pull-left" href="#" target="_parent" style="cursor: none">
<img alt="image" class="img-responsive" src="{{link}}"></a>
<div class="clearfix visible-sm"></div>
<div class="media-body fnt-smaller">
Expand Down
2 changes: 2 additions & 0 deletions js/views/DiggPlayerView.js
Expand Up @@ -29,6 +29,8 @@ define(['jquery', 'backbone', 'text!templates/DiggArticle.html', 'TweenLite', 'S
self._loadPosts();
});
self._listenDispose();

document.body.style.cursor = 'none';
},

/**
Expand Down
1 change: 1 addition & 0 deletions package.json
Expand Up @@ -3,6 +3,7 @@
"name": "digg",
"single-instance": false,
"window": {
"kiosk": false,
"toolbar": true,
"frame": true,
"x": 400,
Expand Down
5 changes: 5 additions & 0 deletions page.css
@@ -1,5 +1,10 @@
* {
font-size: 12px;
cursor: none !important;
}

div img a {
cursor: none !important;
}

.bolding {
Expand Down
1 change: 0 additions & 1 deletion page.html
Expand Up @@ -11,7 +11,6 @@
<link href="_css/fontawesome/css/font-awesome.css" rel="stylesheet">
<link href="page.css" rel="stylesheet">
</head>

<body style="margin-left:10px;">
<h1 style="padding: 20px 20px 20px 0">Digg settings</h1>
<label style="float: left" class="bolding">Background Color</label>
Expand Down
2 changes: 1 addition & 1 deletion version.log
@@ -1 +1 @@
485
494

0 comments on commit b6ecf61

Please sign in to comment.