/
index.html
528 lines (390 loc) · 16.1 KB
/
index.html
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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>The PageJump widget — CometVisu</title>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/theme_override.css" type="text/css" />
<link rel="index" title="Index"
href="../../../genindex.html"/>
<link rel="search" title="Search" href="../../../search.html"/>
<link rel="top" title="CometVisu" href="../../../index.html"/>
<link rel="up" title="Operatable widgets" href="../index.html"/>
<link rel="next" title="The PushButton widget" href="../pushbutton/index.html"/>
<link rel="prev" title="The MultiTrigger widget" href="../multitrigger/index.html"/>
<script src="../../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../../index.html" class="icon icon-home"> CometVisu
<img src="../../../_static/comet_webapp_icon_android_48.png" class="logo" />
</a>
<div class="version">
0.11.0-dev
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Operatable widgets</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../audio/index.html">The Audio widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../designtoggle/index.html">The DesignToggle widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../imagetrigger/index.html">The ImageTrigger widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../infoaction/index.html">The InfoAction widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../infotrigger/index.html">The InfoTrigger widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../multitrigger/index.html">The MultiTrigger widget</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">The PageJump widget</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#settings">Settings</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#allowed-attributes-in-the-pagejump-element">Allowed attributes in the PageJump-element</a></li>
<li class="toctree-l4"><a class="reference internal" href="#allowed-child-elements-und-their-attributes">Allowed child-elements und their attributes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../pushbutton/index.html">The PushButton widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../refresh/index.html">The Refresh widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reload/index.html">The Reload widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../slide/index.html">The Slide widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../switch/index.html">The Switch widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../toggle/index.html">The Toggle widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../trigger/index.html">The Trigger widget</a></li>
<li class="toctree-l2"><a class="reference internal" href="../urltrigger/index.html">The UrlTrigger widget</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../index.html#informative-widgets">Informative widgets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html#other-widgets">Other widgets</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html#widgets-that-can-be-included-as-plugin">Widgets that can be included as plugin</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">CometVisu</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html">Docs</a> »</li>
<li><a href="../index.html">Operatable widgets</a> »</li>
<li>The PageJump widget</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="admonition caution">
<p class="first admonition-title">Caution</p>
<p>This is the documentation for the current development branch of the CometVisu.
It is possible that some of the described features are not yet available in the current release.</p>
<p class="last">Also there might be lots of errors in this documentation as some parts of the content have been translated
by an online translation service.</p>
</div>
<div class="section" id="the-pagejump-widget">
<span id="pagejump"></span><h1>The PageJump widget<a class="headerlink" href="#the-pagejump-widget" title="Permalink to this headline">¶</a></h1>
<div class="line"><div class="line-block">
<div class="line"><strong>Available since version</strong>: 2012</div>
<div class="line"><strong>Author</strong>: Christian Mayer</div>
<div class="line"><br /></div>
</div>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>The pagejump widget can be used to link the visu pages.
The function is similar to hyperlinks.</p>
</div>
<div class="section" id="settings">
<h2>Settings<a class="headerlink" href="#settings" title="Permalink to this headline">¶</a></h2>
<p>For a general understanding of how the configuration files are structured and what elements and attributes are
it is recommended to read this section first: <span class="xref std std-ref">visu-config-details</span>.</p>
<p>The behaviour and appearance of the PageJump widget can be influenced by using certain attributes and elements.
The following tables show the allowed attributes and elements and their possible values.
The screenshots show, how both can be edited in the <span class="xref std std-ref">editor</span>.</p>
<p>Attributes underlined by ..... are mandatory, all the others are optional and be omitted.</p>
<div class="section" id="allowed-attributes-in-the-pagejump-element">
<h3>Allowed attributes in the PageJump-element<a class="headerlink" href="#allowed-attributes-in-the-pagejump-element" title="Permalink to this headline">¶</a></h3>
<table border="1" class="docutils">
<colgroup>
<col width="10%" />
<col width="15%" />
<col width="20%" />
<col width="55%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Element</th>
<th class="head" colspan="4">Attribute</th>
</tr>
<tr class="row-even"><th class="head"> </th>
<th class="head">Name</th>
<th class="head">Content</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-odd"><td rowspan="7">pagejump</td>
<td>name</td>
<td>string</td>
<td> </td>
</tr>
<tr class="row-even"><td>target</td>
<td>string</td>
<td>The name of the page, that should be shown.</td>
</tr>
<tr class="row-odd"><td>align</td>
<td><em>left</em>, <em>right</em> or <em>center</em></td>
<td> </td>
</tr>
<tr class="row-even"><td>flavour</td>
<td>string</td>
<td>Selection of a display variant. See also :ref:’flavour’.</td>
</tr>
<tr class="row-odd"><td>bind_click_to_widget</td>
<td><em>true</em> or <em>false</em></td>
<td>use the whole widget area to react on click events</td>
</tr>
<tr class="row-even"><td>path</td>
<td>string</td>
<td> </td>
</tr>
<tr class="row-odd"><td>active_scope</td>
<td><em>path</em> or <em>target</em></td>
<td> </td>
</tr>
</tbody>
</table>
<div class="figure align-center">
<img alt="config/widgets/pagejump/_static/en_config_widgets_pagejump_index0.png" src="config/widgets/pagejump/_static/en_config_widgets_pagejump_index0.png" />
</div>
<div class="figure align-center">
<img alt="config/widgets/pagejump/_static/en_config_widgets_pagejump_index_editor_attributes.png" src="config/widgets/pagejump/_static/en_config_widgets_pagejump_index_editor_attributes.png" />
</div>
</div>
<div class="section" id="allowed-child-elements-und-their-attributes">
<h3>Allowed child-elements und their attributes<a class="headerlink" href="#allowed-child-elements-und-their-attributes" title="Permalink to this headline">¶</a></h3>
<table border="1" class="schema-table docutils">
<colgroup>
<col width="15%" />
<col width="15%" />
<col width="15%" />
<col width="55%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Element</th>
<th class="head" colspan="4">Attribute</th>
</tr>
<tr class="row-even"><th class="head">Structure</th>
<th class="head">Name</th>
<th class="head">Content</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-odd"><td rowspan="8"><dl class="first last docutils">
<dt>pagejump</dt>
<dd><ul class="first last simple">
<li>layout</li>
</ul>
</dd>
</dl>
</td>
<td>colspan</td>
<td>decimal</td>
<td>Amount of coloumns this widget sould be wide.</td>
</tr>
<tr class="row-even"><td>colspan-m</td>
<td>decimal</td>
<td>Overrules the amount of coloumns on a medium screen.</td>
</tr>
<tr class="row-odd"><td>colspan-s</td>
<td>decimal</td>
<td>Overrules the amount of coloumns on a small screen.</td>
</tr>
<tr class="row-even"><td>rowspan</td>
<td>decimal</td>
<td>Amount of rows this widget should be high.</td>
</tr>
<tr class="row-odd"><td>x</td>
<td>string</td>
<td>Horizontal position of the widget for 2D pages.</td>
</tr>
<tr class="row-even"><td>y</td>
<td>string</td>
<td>Vertical position of the widget for 2D pages.</td>
</tr>
<tr class="row-odd"><td>z</td>
<td>string</td>
<td>Reserved for future use.</td>
</tr>
<tr class="row-even"><td>width</td>
<td>string</td>
<td>Width for the widget for 2D pages.</td>
</tr>
</tbody>
</table>
<table border="1" class="schema-table docutils">
<colgroup>
<col width="15%" />
<col width="15%" />
<col width="15%" />
<col width="55%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Element</th>
<th class="head" colspan="4">Attribute</th>
</tr>
<tr class="row-even"><th class="head">Structure</th>
<th class="head">Name</th>
<th class="head">Content</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-odd"><td rowspan="6"><dl class="first last docutils">
<dt>pagejump</dt>
<dd><ul class="first simple">
<li>label</li>
</ul>
<blockquote class="last">
<div><ul class="simple">
<li>icon</li>
</ul>
</div></blockquote>
</dd>
</dl>
</td>
<td><abbr title="mandatory">name</abbr></td>
<td>string</td>
<td> </td>
</tr>
<tr class="row-even"><td>type</td>
<td>string</td>
<td> </td>
</tr>
<tr class="row-odd"><td>flavour</td>
<td>string</td>
<td>Selection of a display variant. See also :ref:’flavour’.</td>
</tr>
<tr class="row-even"><td>color</td>
<td>string</td>
<td> </td>
</tr>
<tr class="row-odd"><td>styling</td>
<td>string</td>
<td> </td>
</tr>
<tr class="row-even"><td>class</td>
<td>string</td>
<td>Add this value to the CSS class so that it can be formated by a user provided style sheet.</td>
</tr>
<tr class="row-odd"><td><dl class="first last docutils">
<dt>pagejump</dt>
<dd><ul class="first simple">
<li>label</li>
</ul>
<blockquote class="last">
<div><ul class="simple">
<li>#text</li>
</ul>
</div></blockquote>
</dd>
</dl>
</td>
<td> </td>
<td>string</td>
<td>Text to display a label for the widget.</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p>It is possible to manually edit the <span class="xref doc">visu_config.xml</span> and add an entry
for the PageJump widget.</p>
<div class="admonition caution">
<p class="first admonition-title">Caution</p>
<p class="last">Make sure that you only use UTF-8 encoded characters by settings the encoding in your
XML-editor to UTF-8 mode!</p>
</div>
<p class="rubric">Footnotes</p>
<table class="docutils footnote" frame="void" id="f1" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label">[1]</td><td>The simple view might not show everything. To see all elements/attributes use the expert view.</td></tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../pushbutton/index.html" class="btn btn-neutral float-right" title="The PushButton widget" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../multitrigger/index.html" class="btn btn-neutral" title="The MultiTrigger widget" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2010-2017 Christian Mayer and the CometVisu contributers.
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Version</span>
v: 0.11.0-dev
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="../../0.10.0/manual">0.10.0</a></dd>
<dd><a href="../../0.10.2/manual">0.10.2</a></dd>
<dd><a href="../../latest/manual">latest</a></dd>
</dl>
</div>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: ''
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>