> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/layouts/layouts_templates.md).

# Templates

Use Templates to speed up the design process and ensure a corporate standard is maintained.

## Overview:

* Use existing published Layout designs to easily save as Templates.
* Create and manage Templates from a dedicated page for easier management.
* Add Zones to Templates to act as content placeholders on a Layout.
* Set Share options to restrict User access to selected zones on a Template.
* Show Published Templates for selection in the Layout Editor.
* Speed up the entire Layout design process for all Users.
* Apply a standardised look to all Layouts.

Create new Templates or save your existing Layout designs to use as Templates for future Layouts.

{% hint style="info" %}
Select from one of our designed templates from the Xibo Exchange by clicking the button below Templates from the Toolbox. 
{% endhint %}

{% hint style="warning" %}
Selecting a Template will replace the current Layout design to the chosen Template. This action is irreversible and so must be used with caution. 
{% endhint %}

## Create Template

Templates are created by selecting **Templates** under the **Design** section of the main CMS menu

1. Select the **Add Template** button and complete the form fields
2. Give your Template a **Name** for easy identification in the CMS
3. Select the **Resolution**

On **Saving**, the Layout Editor will automatically open with one full size **Zone**.

Zones are used to define areas on a Layout which content can be added to.

{% hint style="info" %}
If you don't want to include any Zones and add content directly to the Template, remove the Zone from the canvas by right clicking and selecting **Delete**. Add content in the same way as creating a Layout.
{% endhint %}

### Adding Zones

{% hint style="warning" %}
Zones are only available for use with Templates!
{% endhint %}

* Click anywhere on the zone to resize and position:

![Template Layout Editor](https://2811002782-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fj0uXhtBdyPyW40TfKTZd%2Fuploads%2Fgit-blob-2d37810eac45fc4a2b97595515ea554595515939%2Fv4_layouts_templates_editor.png?alt=media)

{% hint style="success" %}
Use the buttons, in the bottom right to select to **Snap to Grid**, **Snap to Borders** or **Snap to Elements** for easier positioning when adding items.
{% endhint %}

**Zones** can be added from the toolbar:

* Click on the top **Widget** button.

![Add Zone](https://2811002782-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fj0uXhtBdyPyW40TfKTZd%2Fuploads%2Fgit-blob-a78b45034c442bdeb81c4d4b010a33fae8dfbb0e%2Fv4_layouts_templates_add_zone.png?alt=media)

* Select the Zone and drag and drop or click to add.
* Resize and Position.

{% hint style="warning" %}
Set to **Loop** only if the Zone contains a Widget that needs to update periodically (e.g. RSS Ticker) and it needs to update more frequently than the duration of the overall Layout. 
{% endhint %}

### Layering

From the Properties Panel, select the Positioning tab to set Layering for overlapping Zones/ added content.

Add both content from the Toolbox and Zones to build your Template design.

Once your Template is complete, use the menu at the top of the editor to **Publish**:

![Publish Template](https://2811002782-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fj0uXhtBdyPyW40TfKTZd%2Fuploads%2Fgit-blob-9e23966aa5c03b8a0776dd6ad0146128a21d4c91%2Fv4_layouts_templates_publish.png?alt=media)

Published **Templates** will show for selection from the Toolbox of the Layout Editor.

## Save Layout as Template

Published Layouts can be saved as a **Template** from two locations:

* From the Layout Editor:
  * After **Publishing** go back to the menu and select **Save Template**:

![Save Template Editor](https://2811002782-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fj0uXhtBdyPyW40TfKTZd%2Fuploads%2Fgit-blob-f96aa04cb65b3c994b4ad0f8725bc9ad1646291c%2Fv4_layouts_templates_save_as_template.png?alt=media)

* From the Layouts grid:
  * Use the row menu for a **Published** Layout and **select Save Template**.

Complete all relevant form fields to save the selected Layout as a Template.

{% hint style="info" %}
Optionally use the tick box to also include all added **Widgets** to the Template.
{% endhint %}

* **Save**

Layouts that are saved as a Template can be viewed and edited from the **Templates** grid under the **Design** section of the main CMS menu.

{% hint style="success" %}
**Tagging** a Layout as a 'Template' will also add your designs to your Template list.
{% endhint %}

## Row Menu

All Templates have a row menu where Users can access a list of actions/shortcuts.

* Notable settings are listed below:

#### Alter Template

Select to make design changes to the Template in the Layout Editor.

#### Checkout

To make edits to a Published Template click to **Checkout** and create a draft. Once edited the Template can be published to make the changes permanent overwriting the existing Template. Discard will revert the Template back to its original published state.

{% hint style="info" %}
Take your time with any edits you need to make as using **Checkout** ensures that no changes are made to your published version or shown on scheduled **Displays** until you choose to do so. **Publish** confirms changes have been made and will overwrite your published version. **Discard** will delete the draft with the published version remaining untouched.
{% endhint %}

#### Publish

Publish will ensure that the Template is shown for selection from the Toolbox.

#### Share

Set Share options for User/User Group access to individual Templates.

#### Discard

Discard all changes made to a draft and revert back to the previous Published version.

#### Export

Export the Template including all associated Widgets/Media/DataSet structures to a ZIP file, so it can be easily shared.

When exporting a Template, all assigned **Layout**, **Playlist** and **Media Tags** will be exported. Select the **Import Tags** option to add these Tags on Layout Import.

{% hint style="success" %}
Select multiple Templates and use the short cut actions at the top of the grid to perform bulk actions for multiple Templates.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.xibosignage.com/layouts/layouts_templates.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.