User Manual
On this page
Layout Editor
The Layout Editor is the heart of content creation in Xibo. Each time a new Layout is added, or an existing one needs a design change, the Layout Editor is used.
On adding a new Layout, or clicking Design from the row menu for a Layout, the Layout Editor will open:
Adding a new Layout will will create an ‘untitled’ Layout. Click on the ‘Untitled text’ to Name and complete the form fields:
Folders are used to organise, search and easily Share User objects with other Users/User Groups. Layouts saved to a Folder will inherit the access options applied to that Folder.
- Include optional Tags.
- Enter a string to be used as the Code Identifier to identify this Layout when used with Interactive Actions
- Select to enable the collection of statistics for Proof of Play Reports for the newly added Layout.
- Save.
Properties Panel
The Properties Panel is used to configure all items added to the Layout and the Layout itself.
Select a colour or add an Image to use as your background.
- Add an image from your Library using the Image Library Search from the Toolbar.
- Drag the image to the Background Image area of the properties panel.
-
Select the Resolution that best matches your display.
-
Default Transition settings can be applied to all Widgets on the Layout by ticking the box.
Layering
Zones, content and a Layout background image can be ordered using z-index settings from the positioning tab in the properties panel:
- Click in the item to highlight.
- Select the tab with the grid icon from the properties panel.
- Enter a number to determine the layer.
Right click to show a context menu to easily move items forwards and backwards.
Use the Layer Control Panel at the bottom of the viewer to easily see Layering and durations for all items on the Layout.
Toolbar
Make a start adding content to the Layout from the Toolbar:
Widgets
From the top of the Toolbar, click to utilise a variety of Widgets to add content to your Layouts:
Set Widgets as Favourites to make them easier to select by clicking the star icon in the left hand side of a Widget card:
Add Widgets by drag and drop or click the widget to highlight and click on the viewer.
Data Widgets and Elements
Data Widgets also contain ‘data’ Elements which allows a User to place each element of the Widget exactly where needed rather than being bound by a Static Template design:
Each Widget has a set of Elements which are fed with the data returned by the Widget. Once added to the viewer, each Element has a set of configurable options available in the properties panel:
Elements have their own Layer, which can be used to determine where they appear in relation to other natively rendered Elements such as Playlists and Videos.
Click to highlight an Element and click the positioning tab in the properties panel:
Data Slots
Handle the paging of data when using more than one of the same Element for a Widget by specifying a Data Slot to use for each Element added.
In addition Elements have the option to Pin this slot so that the first data item to appear in that slot will stay there for the entire duration of the Widget and won’t cycle through items with the others.
Grouping Elements
Elements can be grouped and treated as ‘one’ for ease of configuration,positioning, resizing and duplication:
NOTE: All Data Elements need to share the same Data Slot and Effect when grouping!
- Hold down the shift key to multi-select and click in each Element to group.
- Once the Elements have been selected, right click and select Group elements:
Stencils
Stencils are ‘Element Group Templates’ which have been included for selected Widgets to assist Users with creating content simply and quickly.
Static Templates
Templates are included for specific Widgets to provide an easy way to add content using a pre-styled design. Templates can be configured to affect the behavior of returned results as well as alter styling options to suit your requirements.
Static Templates are predominantly used in the Playlist Editor and are available to add to Layouts.
Global Elements
Easily add Text and a variety of shapes to your Layout:
Library Search
Select from Image, Audio, Video and Other media file searches to easily assign media which already exists in the Library.
When using Image/Video Library Search options, Integration from Pixabay gives users additional resources which can be added to Layouts without having to leave the Layout Editor.
If you are upgrading from an earlier version you will need to enable by navigating to the Administration section of the CMS and click Applications. Scroll down the page to the Connectors section. Click to Configure and tick to enable, Save changes.
Pixabay can be enabled from the Administration section of the CMS menu by clicking on Applications and scrolling down the page to the Connectors section. Click Configure and enter your API Key after signing up for a Pixabay account. PixabayAPI Documentation
Interactive Actions
Widgets can have Actions attached to effect changes to the Layout triggered by Touch, click or webhook. Interactive Actions are created and managed from the Toolbar and shown on the Actions tab for the selected item in the Properties Panel.
Templates
Select a Template to use from the Toolbar.
Select from one of our templates available from the Xibo Exchange.
Selecting a Template will replace the Layout you are currently working on with your chosen Template. (This action is irreversible and so must be used with caution)
Viewer
The viewer will update as the Layout is designed so that you can clearly see your designs taking shape.
Position content exactly where you want it with flexible drag and drop, rotation and resizing tools.
Layer Control
Located in the bottom left of the viewer, easily view all Layering and Durations of all items added to the Layout.
Context Menu
Further options are available from a Context Menu located at the bottom of the viewer as well as from a right click on added items. Actions shown are dependent on what you have selected.
Audio
Attach an Audio file to a Widget.
Sharing
Control Sharing options to View, Edit and Delete selected items for Users/User Groups.
Preview
Play a full Preview of your Layout by clicking on the Play button located at the bottom of the viewer:
Status Bar
View the current status, edit Naming, Tags, Folders etc. and see the overall duration of the Layout using the status bar at the top left of the Layout Editor. Layout duration is based on the longest running item on the Layout:
The icon shows you the current status of the selected Layout:
Blue cog - the Layout has not been built yet.
Green tick - the Layout is valid and can be published and scheduled.
Red cross - the Layout is invalid and should not be published for scheduling.
Orange exclamation mark - the Layout contains media that can only be assessed Player side and can be published an scheduled.
Mouse over the status icon to view further information.
The last icon is a normal Layout status to have if your Layout contains online content, such as a webpage etc. The CMS cannot say that the Player will display the content as it is not sent directly from the CMS (as with file based media, images, videos etc,) and is instead cached (stored) Player side. The Player will need to have a reliable internet connection to successfully display such content.
The Layout jump list provides easy navigation between all Layouts the logged in User has access to edit without having to leave the Layout Editor.
Publish
Once your Layout design is complete you must ensure that you Publish your Layout before Scheduling. Use the Menu located to the far right of the status bar to view all options for your Layout:
Layouts can be set to be Published straight away with updates automatically pushed to Layouts that are in the schedule. A Publish Date can also be selected to Publish a Layout at a specified date and time.
