1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
|
{#
/*
* Spring Signage Ltd - http://www.springsignage.com
* Copyright (C) 2015-17 Spring Signage Ltd
* (ticker-form-edit.twig)
*/
#}
{% extends "form-base.twig" %}
{% import "forms.twig" as forms %}
{% block formTitle %}
{% if module.getOption("sourceId") == 2 %}
{% set dataSetName = module.getExtra().dataSet.dataSet %}
{% trans %}Edit Ticker: DataSet is {{ dataSetName }}{% endtrans %}
{% else %}
{% trans "Edit Ticker" %}
{% endif %}
{% endblock %}
{% block formButtons %}
{% trans "Cancel" %}, XiboDialogClose()
{% trans "Apply" %}, XiboDialogApply("#tickerEditForm")
{% trans "Save" %}, $("#tickerEditForm").submit()
{% endblock %}
{% block callBack %}dataSetTickerFormSetup{% endblock %}
{% block extra %}{{ module.getExtra()|json_encode|raw }}{% endblock %}
{% block formFieldActions %}
[{
"field": "useDuration",
"trigger": "init",
"value": false,
"operation": "is:checked",
"actions": {
".duration-fields": { "display": "none" }
}
},{
"field": "useDuration",
"trigger": "change",
"value": false,
"operation": "is:checked",
"actions": {
".duration-fields": { "display": "none" }
}
},{
"field": "useDuration",
"trigger": "init",
"value": true,
"operation": "is:checked",
"actions": {
".duration-fields": { "display": "block" }
}
},{
"field": "useDuration",
"trigger": "change",
"value": true,
"operation": "is:checked",
"actions": {
".duration-fields": { "display": "block" }
}
}
{% if module.getOption("sourceId") == 1 %}
,{
"field": "overrideTemplate",
"trigger": "init",
"value": false,
"operation": "is:checked",
"actions": {
".template-override-controls": { "display": "none" },
".template-selector-control": { "display": "block" }
}
},{
"field": "overrideTemplate",
"trigger": "change",
"value": false,
"operation": "is:checked",
"actions": {
".template-override-controls": { "display": "none" },
".template-selector-control": { "display": "block" }
}
},{
"field": "overrideTemplate",
"trigger": "init",
"value": true,
"operation": "is:checked",
"actions": {
".template-override-controls": { "display": "block" },
".template-selector-control": { "display": "none" }
}
},{
"field": "overrideTemplate",
"trigger": "change",
"value": true,
"operation": "is:checked",
"actions": {
".template-override-controls": { "display": "block" },
".template-selector-control": { "display": "none" }
}
}
{% else %}
,{
"field": "useOrderingClause",
"trigger": "init",
"value": false,
"operation": "is:checked",
"actions": {
".order-clause-field": { "display": "none" },
"#orderClause": { "display": "block" }
}
},{
"field": "useOrderingClause",
"trigger": "change",
"value": false,
"operation": "is:checked",
"actions": {
".order-clause-field": { "display": "none" },
"#orderClause": { "display": "block" }
}
},{
"field": "useOrderingClause",
"trigger": "init",
"value": true,
"operation": "is:checked",
"actions": {
".order-clause-field": { "display": "block" },
"#orderClause": { "display": "none" }
}
},{
"field": "useOrderingClause",
"trigger": "change",
"value": true,
"operation": "is:checked",
"actions": {
".order-clause-field": { "display": "block" },
"#orderClause": { "display": "none" }
}
},{
"field": "useFilteringClause",
"trigger": "init",
"value": false,
"operation": "is:checked",
"actions": {
".filter-clause-field": { "display": "none" },
"#filterClause": { "display": "block" }
}
},{
"field": "useFilteringClause",
"trigger": "change",
"value": false,
"operation": "is:checked",
"actions": {
".filter-clause-field": { "display": "none" },
"#filterClause": { "display": "block" }
}
},{
"field": "useFilteringClause",
"trigger": "init",
"value": true,
"operation": "is:checked",
"actions": {
".filter-clause-field": { "display": "block" },
"#filterClause": { "display": "none" }
}
},{
"field": "useFilteringClause",
"trigger": "change",
"value": true,
"operation": "is:checked",
"actions": {
".filter-clause-field": { "display": "block" },
"#filterClause": { "display": "none" }
}
}
{% endif %}
]
{% endblock %}
{% block formHtml %}
<div class="row">
<div class="col-md-12">
<ul class="nav nav-tabs" role="tablist">
<li class="active"><a href="#general" role="tab" data-toggle="tab"><span>{% trans "General" %}</span></a></li>
<li><a href="#template" role="tab" data-toggle="tab"><span>{% trans "Apperance" %}</span></a></li>
{% if module.getOption("sourceId") == 2 %}
<li><a href="#orderCriteria" role="tab" data-toggle="tab"><span>{% trans "Order" %}</span></a></li>
<li><a href="#filterCriteria" role="tab" data-toggle="tab"><span>{% trans "Filter" %}</span></a></li>
{% endif %}
<li><a href="#format" role="tab" data-toggle="tab"><span>{% trans "Format" %}</span></a></li>
<li><a href="#advanced" role="tab" data-toggle="tab"><span>{% trans "Advanced" %}</span></a></li>
</ul>
<form id="tickerEditForm" class="XiboForm form-horizontal" method="put" action="{{ urlFor("module.widget.edit", {id: module.widget.widgetId}) }}">
<div class="tab-content">
{# Common Fields #}
{% set title %}{% trans "Name" %}{% endset %}
{% set helpText %}{% trans "An optional name for this widget" %}{% endset %}
{% set fieldName %}{{ forms.input("name", title, module.getOption("name"), helpText) }}{% endset %}
{% set title %}{% trans "Set a duration?" %}{% endset %}
{% set helpText %}{% trans "Select to provide a specific duration for this Widget" %}{% endset %}
{% set fieldUseDuration %}{{ forms.checkbox("useDuration", title, module.getUseDuration(), helpText) }}{% endset %}
{% set title %}{% trans "Duration" %}{% endset %}
{% set helpText %}{% trans "The duration in seconds this item should be displayed" %}{% endset %}
{% set fieldDuration %}{{ forms.number("duration", title, module.getDuration(), helpText, "duration-fields", "required") }}{% endset %}
{% set title %}{% trans "Effect" %}{% endset %}
{% set helpText %}{% trans "Please select the effect that will be used to transition between items. Marquee effects are CPU intensive and may not be suitable for lower power displays." %}{% endset %}
{% set showAll %}{% trans "Show all items" %}{% endset %}
{% set showPaged %}{% trans "Paged" %}{% endset %}
{% set marqueeLeft %}{% trans "Marquee Left" %}{% endset %}
{% set marqueeRight %}{% trans "Marquee Right" %}{% endset %}
{% set marqueeUp %}{% trans "Marquee Up" %}{% endset %}
{% set marqueeDown %}{% trans "Marquee Down" %}{% endset %}
{% set optionGroups = [
{id: "showAll", label: showAll},
{id: "showPaged", label: showPaged}
] %}
{% set noneOption %}{% trans "No effect - all items are shown" %}{% endset %}
{% set showAllOptions = [
{ effectid: "none", effect: noneOption },
{ effectid: "marqueeLeft", effect: marqueeLeft},
{ effectid: "marqueeRight", effect: marqueeRight},
{ effectid: "marqueeUp", effect: marqueeUp},
{ effectid: "marqueeDown", effect: marqueeDown}
] %}
{% set noTransitionOption %}{% trans "No transition" %}{% endset %}
{% set fade %}{% trans "Fade" %}{% endset %}
{% set fadeout %}{% trans "Fade Out" %}{% endset %}
{% set scrollHorz %}{% trans "Scroll Horizontal" %}{% endset %}
{% set scrollVert %}{% trans "Scroll Vertical" %}{% endset %}
{% set flipHorz %}{% trans "Flip Horizontal" %}{% endset %}
{% set flipVert %}{% trans "Flip Vertical" %}{% endset %}
{% set shuffle %}{% trans "Shuffle" %}{% endset %}
{% set tileSlide %}{% trans "Tile Slide" %}{% endset %}
{% set tileBlind %}{% trans "Tile Blind" %}{% endset %}
{% set showPagedOptions = [
{ effectid: "noTransition", effect: noTransitionOption },
{ effectid: "fade", effect: fade },
{ effectid: "fadeout", effect: fadeout},
{ effectid: "scrollHorz", effect: scrollHorz},
{ effectid: "scrollVert", effect: scrollVert},
{ effectid: "flipHorz", effect: flipHorz},
{ effectid: "flipVert", effect: flipVert},
{ effectid: "shuffle", effect: shuffle},
{ effectid: "tileSlide", effect: tileSlide},
{ effectid: "tileBlind", effect: tileBlind}
] %}
{% set fieldEffect %}{{ forms.dropdown("effect", "single", title, module.getOption("effect"), {showAll: showAllOptions, showPaged: showPagedOptions}, "effectid", "effect", helpText, "l", "", "", "", "", optionGroups) }}{% endset %}
{% set title %}{% trans "Speed" %}{% endset %}
{% set helpText %}{% trans "The transition speed of the selected effect in milliseconds (normal = 1000) or the Marquee Speed in a low to high scale (normal = 1)." %}{% endset %}
{% set fieldSpeed %}{{ forms.number("speed", title, module.getOption("speed", module.getOption("scrollSpeed")), helpText, "effect-controls") }}{% endset %}
{% set title %}{% trans "Background Colour" %}{% endset %}
{% set helpText %}{% trans "The selected effect works best with a background colour. Optionally add one here." %}{% endset %}
{% set fieldBackgroundColor %}{{ forms.input("backgroundColor", title, module.getOption("backgroundColor"), helpText, "background-color-group") }}{% endset %}
{% set title %}{% trans "Items per page" %}{% endset %}
{% set helpText %}{% trans "If an effect has been selected from the General tab, how many pages should we split the items across? If you don't enter anything here 1 item will be put on each page." %}{% endset %}
{% set fieldItemsPerPage %}{{ forms.number("itemsPerPage", title, module.getOption("itemsPerPage"), helpText, "effect-controls") }}{% endset %}
{% set title %}{% trans "Update Interval (mins)" %}{% endset %}
{% set helpText %}{% trans "Please enter the update interval in minutes. This should be kept as high as possible. For example, if the data will only change once per hour this could be set to 60." %}{% endset %}
{% set fieldUpdateInterval %}{{ forms.number("updateInterval", title, module.getOption("updateInterval", 5), helpText, "", "required") }}{% endset %}
{% set title %}{% trans "Duration is per item" %}{% endset %}
{% set helpText %}{% trans "The duration specified is per item otherwise it is per feed." %}{% endset %}
{% set fieldDurationIsPerItem %}{{ forms.checkbox("durationIsPerItem", title, module.getOption("durationIsPerItem"), helpText) }}{% endset %}
{% set title %}{% trans "Show items side by side?" %}{% endset %}
{% set helpText %}{% trans "Should items be shown side by side?" %}{% endset %}
{% set fieldItemsSideBySide %}{{ forms.checkbox("itemsSideBySide", title, module.getOption("itemsSideBySide"), helpText) }}{% endset %}
{% set helpText %}
{% trans "Enter the template. Please note that the background colour has automatically coloured to your layout background colour." %}
{% trans "The red rectangle reflects the size of the region you are editing." %}
{% trans "Shift+Enter will drop a single line. Enter alone starts a new paragraph." %}
{% endset %}
{% set fieldTemplate %}{{ forms.textarea("ta_text", "", module.getRawNode("template"), helpText, "template-override-controls", "", 10) }}{% endset %}
{% set title %}{% trans "Optional Stylesheet" %}{% endset %}
{% set fieldStyleSheet %}{{ forms.textarea("ta_css", "", module.getRawNode("css"), title, "template-override-controls", "", 10) }}{% endset %}
{% set title %}{% trans "Optional JavaScript" %}{% endset %}
{% set fieldJavaScript %}{{ forms.textarea("javaScript", "", module.getRawNode("javaScript"), title, "", "", 10) }}{% endset %}
{% set helpText %}{% trans "A message to display when no data is returned from the source" %}{% endset %}
{% set fieldNoDataMessage %}{{ forms.textarea("noDataMessage", "", module.getRawNode("noDataMessage"), helpText, "", "", 5) }}{% endset %}
{# Different fields for each type of Ticker #}
{% if module.getOption("sourceId") == 1 %}
{# Source = Feed #}
<div class="tab-pane active" id="general">
{% set title %}{% trans "Feed URL" %}{% endset %}
{% set helpText %}{% trans "The Link for the RSS feed" %}{% endset %}
{{ forms.input("uri", title, module.getOption("uri")|url_decode, helpText, "feed-fields") }}
{{ fieldName }}
{{ fieldUseDuration }}
{{ fieldDuration }}
{{ fieldEffect }}
</div>
<div class="tab-pane" id="template">
{% set title %}{% trans "Template" %}{% endset %}
{% set helpText %}{% trans "Select the template you would like to apply. This can be overridden using the check box below." %}{% endset %}
{{ forms.dropdown("templateId", "single", title, module.getOption("templateId", "title-only"), module.templatesAvailable(), "id", "value", helptext, "template-selector-control selectPicker selectPickerWithImage", null, null, null, null, null, baseUrl, "image") }}
{% set title %}{% trans "Override the template?" %}{% endset %}
{% set helpText %}{% trans "Tick if you would like to override the template." %}{% endset %}
{{ forms.checkbox("overrideTemplate", title, module.getOption("overrideTemplate", 0), helpText) }}
<div class="well template-override-controls">
<div class="text-center text-info">{% trans "Available Substitutions" %}</div>
<ul id="TickerDataSetColumns">
<li class="ckeditor_snippits" linkedto="ta_text">Name</li>
<li class="ckeditor_snippits" linkedto="ta_text">Title</li>
<li class="ckeditor_snippits" linkedto="ta_text">Description</li>
<li class="ckeditor_snippits" linkedto="ta_text">Date</li>
<li class="ckeditor_snippits" linkedto="ta_text">Content</li>
<li class="ckeditor_snippits" linkedto="ta_text">Copyright</li>
<li class="ckeditor_snippits" linkedto="ta_text">Link</li>
<li class="ckeditor_snippits" linkedto="ta_text">PermaLink</li>
<li class="ckeditor_snippits" linkedto="ta_text">Tag|Namespace</li>
</ul>
</div>
{{ fieldTemplate }}
{{ fieldStyleSheet }}
</div>
<div class="tab-pane" id="format">
{{ fieldSpeed }}
{% set title %}{% trans "Text direction" %}{% endset %}
{% set helpText %}{% trans "Which direction does the text in the feed use?" %}{% endset %}
{% set leftToRight %}{% trans "Left to Right (LTR)" %}{% endset %}
{% set rightToLeft %}{% trans "Right to Left (RTL)" %}{% endset %}
{% set options = [
{ textdirectionid: "ltr", textdirection: leftToRight },
{ textdirectionid: "rtl", textdirection: rightToLeft }
] %}
{{ forms.dropdown("textDirection", "single", title, module.getOption("textDirection", "ltr"), options, "textdirectionid", "textdirection", helpText) }}
{% set title %}{% trans "Number of Items" %}{% endset %}
{% set helpText %}{% trans "The Number of RSS items you want to display" %}{% endset %}
{{ forms.number("numItems", title, module.getOption("numItems"), helpText) }}
{{ fieldItemsPerPage }}
{% set title %}{% trans "Take items from the" %}{% endset %}
{% set helpText %}{% trans "Take the items from the beginning or the end of the list" %}{% endset %}
{% set startOfTheFeed %}{% trans "Start of the Feed" %}{% endset %}
{% set endOfTheFeed %}{% trans "End of the Feed" %}{% endset %}
{% set options = [
{ takeitemsfromid: "start", takeitemsfrom: startOfTheFeed },
{ takeitemsfromid: "end", takeitemsfrom: endOfTheFeed }
] %}
{{ forms.dropdown("takeItemsFrom", "single", title, module.getOption("takeItemsFrom", "start"), options, "takeitemsfromid", "takeitemsfrom", helpText) }}
{{ fieldDurationIsPerItem }}
{% set title %}{% trans "Randomise?" %}{% endset %}
{% set helpText %}{% trans "Should the order of the feed be randomised? When enabled each time the Widget is shown the items will be randomly shuffled and displayed in a random order." %}{% endset %}
{{ forms.checkbox("randomiseItems", title, module.getOption("randomiseItems"), helpText) }}
</div>
<div class="tab-pane" id="advanced">
{{ fieldBackgroundColor }}
{{ fieldUpdateInterval }}
{% set title %}{% trans "Copyright" %}{% endset %}
{% set helpText %}{% trans "Copyright information to display as the last item in this feed. This can be styled with the #copyright CSS selector." %}{% endset %}
{{ forms.input("copyright", title, module.getOption("copyright"), helpText) }}
{{ fieldItemsSideBySide }}
{% set title %}{% trans "Date Format" %}{% endset %}
{% set manualUrl %}{{ helpService.address("advanced_dateFormat.html") }}{% endset %}
{% set helpText %}{% trans %}The format to apply to all dates returned by the ticker. See the <a href="{{ manualUrl }}">Manual</a> for allowed formats.{% endtrans %}{% endset %}
{{ forms.input("dateFormat", title, module.getOption("dateFormat"), helpText) }}
{% set title %}{% trans "Allowable Attributes" %}{% endset %}
{% set helpText %}{% trans "A comma separated list of attributes that should not be stripped from the incoming feed." %}{% endset %}
{{ forms.input("allowedAttributes", title, module.getOption("allowedAttributes"), helpText) }}
{% set title %}{% trans "Strip Tags" %}{% endset %}
{% set helpText %}{% trans "A comma separated list of HTML tags that should be stripped from the feed in addition to the default ones." %}{% endset %}
{{ forms.input("stripTags", title, module.getOption("stripTags"), helpText) }}
{% set title %}{% trans "Disable Date Sort" %}{% endset %}
{% set helpText %}{% trans "Should the date sort applied to the feed be disabled?" %}{% endset %}
{{ forms.checkbox("disableDateSort", title, module.getOption("disableDateSort"), helpText) }}
{{ fieldNoDataMessage }}
{{ fieldJavaScript }}
</div>
{% else %}
{# Source = Dataset #}
<div class="tab-pane active" id="general">
{{ fieldName }}
{{ fieldUseDuration }}
{{ fieldDuration }}
{{ fieldEffect }}
{{ fieldSpeed }}
</div>
<div class="tab-pane" id="template">
<div class="well">
<div class="text-center text-info">{% trans "Available Substitutions" %}</div>
<ul id="TickerDataSetColumns">
{% for column in module.dataSetColumns() %}
<li class="ckeditor_snippits" linkedto="ta_text" datasetcolumnid="{{ column.dataSetColumnId }}">{{ column.heading }}</li>
{% endfor %}
</ul>
</div>
{{ fieldTemplate }}
{{ fieldStyleSheet }}
</div>
<div class="tab-pane" id="orderCriteria">
{% set message %}{% trans "The DataSet results can be ordered by any column and set below. New fields can be added by selecting the plus icon at the end of the current row. Should a more complicated order be required the advanced checkbox can be selected to provide custom SQL syntax." %}{% endset %}
{{ forms.message(message) }}
<div id="orderClause">
</div>
{% set title %}{% trans "Use advanced order clause?" %}{% endset %}
{% set helpText %}{% trans "Provide a custom clause instead of using the clause builder above." %}{% endset %}
{{ forms.checkbox("useOrderingClause", title, module.getOption("useOrderingClause", 0), helpText) }}
{% set title %}{% trans "Order" %}{% endset %}
{% set helpText %}{% trans "Please enter a SQL clause for how this dataset should be ordered" %}{% endset %}
{{ forms.input("ordering", title, module.getOption("ordering"), helpText, "order-clause-field") }}
</div>
<div class="tab-pane" id="filterCriteria">
{% set message %}{% trans "The DataSet results can be filtered by any column and set below. New fields can be added by selecting the plus icon at the end of the current row. Should a more complicated filter be required the advanced checkbox can be selected to provide custom SQL syntax." %}{% endset %}
{{ forms.message(message) }}
<div id="filterClause">
</div>
{% set title %}{% trans "Use advanced filter clause?" %}{% endset %}
{% set helpText %}{% trans "Provide a custom clause instead of using the clause builder above." %}{% endset %}
{{ forms.checkbox("useFilteringClause", title, module.getOption("useFilteringClause", 0), helpText) }}
{% set title %}{% trans "Filter" %}{% endset %}
{% set helpText %}{% trans "Please enter a SQL clause to filter this DataSet." %}{% endset %}
{{ forms.input("filter", title, module.getOption("filter"), helpText, "filter-clause-field") }}
</div>
<div class="tab-pane" id="format">
{{ fieldItemsPerPage }}
{{ fieldItemsSideBySide }}
</div>
<div class="tab-pane" id="advanced">
{{ fieldBackgroundColor }}
{{ fieldDurationIsPerItem }}
{{ fieldUpdateInterval }}
{% set title %}{% trans "Lower Row Limit" %}{% endset %}
{% set helpText %}{% trans "Please enter the Lower Row Limit for this DataSet (enter 0 for no limit)" %}{% endset %}
{{ forms.number("lowerLimit", title, module.getOption("lowerLimit"), helpText) }}
{% set title %}{% trans "Upper Row Limit" %}{% endset %}
{% set helpText %}{% trans "Please enter the Upper Row Limit for this DataSet (enter 0 for no limit)" %}{% endset %}
{{ forms.number("upperLimit", title, module.getOption("upperLimit"), helpText) }}
{{ fieldNoDataMessage }}
{{ fieldJavaScript }}
</div>
{% endif %}
</div>
</form>
</div>
</div>
{% endblock %}
|