TaleArt docs

Type a word to find a page, a heading or a sentence in the docs.

GitHub

Getting started

TaleArt shows tales (full-screen pages of images, video and text) in spots on your site called zones. This page takes you from a new project to a tale on a test page.

Start with the Web guideBrowse the reference

Build with an SDK

Each platform guide takes a zone from its key to a visible tale in an app or site, step by step.

From sign-up to a visible tale

  1. Set up TaleArt and name your first project: your app or site.
  2. New zone. Name the spot (for example "Home – top"), keep or change its slug (home-top, the name a page uses for it) and pick a template: Stories bar, Promo banner or Blank. The template sets the zone's display once.
  3. New tale group. On the zone page, create a tale group and add images or videos: each file becomes a tale. New tales are Shown.
  4. Turn the group On. Its Shown tales are now visible in the zone.
  5. Install tab. Issue the zone key (admins), then copy the snippet or choose Open test page. The zone page says Visible on site once everything is in place.

The snippet looks like this, with your API URL filled in:

<script type="module" src="https://api.example.com/sdk/v1/taleart.js"></script>
<!-- Optional, once per page: <script>Taleart.init({ locale: "en" })</script> -->
<taleart-view zone-key="YOUR_ZONE_KEY"></taleart-view>

Put it in any page of your site, with the zone's key in place of YOUR_ZONE_KEY. Install a zone explains each part.

Visible on site, or not visible because…

Every zone, tale group and tale in the dashboard says Visible on site or Not visible: and the first reason, such as "group is off", "zone has no display" or "zone not installed" (the zone has no zone key yet). The dashboard and the Delivery API decide visibility with the same rule.

Next: Concepts explains zones, displays, templates and the rest, and Visibility and troubleshooting explains a zone that does not show.

All pages

The same groups as the navigation.

Introduction

Installation

Campaigns

Workspace

SDK guides

Reference

Edit this page on GitHub