~bakkerl/xibo/1.6

« back to all changes in this revision

Viewing changes to server/manual/content/layout/addregion.php

  • Committer: Dan Garner
  • Date: 2014-01-19 14:06:56 UTC
  • mfrom: (292.1.48 server-160rc1)
  • Revision ID: dan@xibo.org.uk-20140119140656-4xqs9tjqlgcbaaq9
Merged 1.6.0rc1 manual branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2
 
<?php include('../../template.php'); ?>
3
 
<html>
4
 
<head>
5
 
        <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
6
 
        <title><?php echo PRODUCT_NAME; ?> Documentation</title>
7
 
        <link rel="stylesheet" type="text/css" href="../../css/doc.css">
8
 
        <meta name="keywords" content="digital signage, signage, narrow-casting, <?php echo PRODUCT_NAME; ?>, open source, agpl" />
9
 
        <meta name="description" content="<?php echo PRODUCT_NAME; ?> 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." />
10
 
        <link href="img/favicon.ico" rel="shortcut icon">
11
 
        <!-- Javascript Libraries -->
12
 
        <script type="text/javascript" src="lib/jquery.pack.js"></script>
13
 
        <script type="text/javascript" src="lib/jquery.dimensions.pack.js"></script>
14
 
        <script type="text/javascript" src="lib/jquery.ifixpng.js"></script>
15
 
</head>
16
 
 
17
 
<body>
18
 
        <a name="Adding_Regions" id="Adding_Regions"></a><h2>Adding Regions</h2>
19
 
 
20
 
        <p>As you make the region smaller, you'll see the background (layout canvas) behind. Right click on the background and choose "Add Region".</p>
21
 
 
22
 
        <p><img alt="Layout Designer Screenshot - Add Region" src="Ss_layout_designer_add_region.png"
23
 
        style="display: block; text-align: center; margin-left: auto; margin-right: auto"
24
 
        width="403" height="244"></p>
25
 
 
26
 
        <p>You should see a new region appears. You can move it around or resize it in the same way as you did before.</p>
27
 
        <p>If you intend to display video within the region it is advisable to ensure that the region provides the same aspect ratio as the video,
28
 
        otherwise black spaces will be visible.</p>
29
 
 
30
 
        <a name="Removing_Regions" id="Removing_Regions"></a><h2>Removing Regions</h2>
31
 
        <p>If you decide you do not want a region any more, right click on it and choose "Delete". <br />
32
 
        Note that you will loose any media items contained in the region that are not in the library (eg Text, RSS Tickers, Embedded HTML).</p>
33
 
 
34
 
        <p><img alt="Layout Designer Screenshot - Delete Region" src="Ss_layout_designer_delete_region.png"
35
 
        style="display: block; text-align: center; margin-left: auto; margin-right: auto"
36
 
        width="289" height="197"></p>
37
 
 
38
 
        <a name="Region_Permission" id="Region_Permission"></a><h2>Regions Permissions</h2>
39
 
 
40
 
        <p>The owner of the layout has full control on how the new layout is to be shared. A globally shared layout may have one of its
41
 
        layout region access rights being disabled for any other user edit. Right click within the region and select "Permissions"
42
 
        to define the selected region access rights to other users of the <?php echo PRODUCT_NAME; ?> system</p> 
43
 
 
44
 
        <p><img alt="Region Permissions" src="Ss_layout_region_permissions.png"
45
 
        style="display: block; text-align: center; margin-left: auto; margin-right: auto"
46
 
        width="358" height="286"></p>
47
 
 
48
 
        <?php include('../../template/footer.php'); ?>
49
 
</body>
50
 
</html>
 
1
<?php
 
2
/*
 
3
 * Xibo - Digital Signage - http://www.xibo.org.uk
 
4
 * Copyright (C) 2006-2013 Daniel Garner
 
5
 *
 
6
 * This file is part of Xibo.
 
7
 *
 
8
 * Xibo is free software: you can redistribute it and/or modify
 
9
 * it under the terms of the GNU Affero General Public License as published by
 
10
 * the Free Software Foundation, either version 3 of the License, or
 
11
 * any later version. 
 
12
 *
 
13
 * Xibo is distributed in the hope that it will be useful,
 
14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
16
 * GNU Affero General Public License for more details.
 
17
 *
 
18
 * You should have received a copy of the GNU Affero General Public License
 
19
 * along with Xibo.  If not, see <http://www.gnu.org/licenses/>.
 
20
 */ 
 
21
defined('XIBO') or die("Sorry, you are not allowed to directly access this page.<br /> Please press the back button in your browser.");
 
22
?>
 
23
<h1>Regions</h1>
 
24
<p>Regions are defined areas on the Layout that can hold sets of content (called Timelines). Regions can be moved around inside the Layout using drag and drop, and resized using the Resize Handle in the Lower Right hand corner of the Region.</p>
 
25
 
 
26
<p><img class="img-thumbnail" alt="Layout Designer Screenshot" src="content/layout/layout_designer_region_resize.png"></p>
 
27
 
 
28
<p>With each change to a Region a "Save Position" button will appear at the top of the Layout. This must be clicked to Save the Changes that have been made.</p>
 
29
 
 
30
<p class="alert alert-info">If a Layout has been created from a Template it will most likely have a full screen Region pre-created - Regions are shown on the Layout Designer as semi-transparent white overlays.</p>
 
31
 
 
32
<p class="alert alert-danger">The Display clients have limited support for overlapping Regions - for the best compatibility please sure the Regions do not overlap.</p>
 
33
 
 
34
<h2 id="Adding_Regions">Adding Regions</h2>
 
35
 
 
36
<p>Regions are added using the Layout Designer Options Menu, pictured below.</p>
 
37
 
 
38
<p><img class="img-thumbnail" alt="Layout Designer Screenshot" src="content/layout/layout_designer_options_menu.png"></p>
 
39
 
 
40
<p>Once the menu item is clicked a new region appears and is ready to be moved or resized by the designer.</p>
 
41
 
 
42
<p><img class="img-thumbnail" alt="New Region Added" src="content/layout/Ss_layout_designer_add_region.png"></p>
 
43
 
 
44
 
 
45
<h2 id="Region Menu">Region Menu</h2>
 
46
<p>Each Region has its own menu of Actions - similar to the Action menu found on the Layout Table. The Action menu for Regions always appears at the top right of the Region and also shows the Width, Height and Coordinates.</p>
 
47
 
 
48
<p><img class="img-thumbnail" alt="Layout Designer Screenshot - Add Region" src="content/layout/layout_designer_region_menu.png"></p>
 
49
 
 
50
<dl class="dl-horizontal">
 
51
        <dt>Edit Timeline</dt>
 
52
        <dd>Assign content to this Region or change the sequence of existing content.</dd>
 
53
</dl>
 
54
 
 
55
<dl class="dl-horizontal">
 
56
        <dt>Options</dt>
 
57
        <dd>Assign the Region a name and manually adjust its width, height and coordinates.</dd>
 
58
</dl>
 
59
 
 
60
<dl class="dl-horizontal">
 
61
        <dt>Delete</dt>
 
62
        <dd>Completely remove this Region and all its associated content.</dd>
 
63
</dl>
 
64
 
 
65
<dl class="dl-horizontal">
 
66
        <dt>Permissions</dt>
 
67
        <dd>Control which users and user groups can view/edit/delete this Region.</dd>
 
68
</dl>
 
69
 
 
70
<p class="alert alert-info">Ideally Regions that are indended for Video content should be at the same aspect ratio as the indented content.</p>
 
71
 
 
72
 
 
73
<h2 id="Removing_Regions">Deleting a Region</h2>
 
74
<p>Note that you will loose any media items contained in the region that are not in the library (eg Text, RSS Tickers, Embedded HTML).</p>
 
75
 
 
76
<p><img class="img-thumbnail" class="img-thumbnail" alt="Layout Designer Screenshot - Delete Region" src="content/layout/Ss_layout_designer_delete_region.png"></p>
 
77
 
 
78
<h2>Options</h2>
 
79
<p>The Region options form allows for naming a region, precise sizing and positioning and exit transitions.</p>
 
80
 
 
81
<p><img class="img-thumbnail" alt="Layout Region Options" src="content/layout/Ss_layout_region_options.png"></p>
 
82
 
 
83
<p class="alert alert-info">To get a full screen Region go into the Region options and select "Set Full Screen".</p>
 
84
 
 
85
<h2 id="Region_Permission">Permissions</h2>
 
86
<p>The owner of the layout has full control on how the new layout is to be shared. A globally shared layout may have one of its layout region access rights being disabled for any other user edit. Right click within the region and select "Permissions" to define the selected region access rights to other users of the <?php echo PRODUCT_NAME; ?> CMS</p>