TaleArt docsConcepts
The words the dashboard, the Web SDK and these docs use, and what each one means.
| Term | Meaning | Example |
|---|---|---|
| Project | Your app or site. Holds everything below, plus the theme, the fonts and the site key (the server-side key). | Acme Shop |
| Zone | One spot in your app or site where tales appear. A page can have several zones, and a zone can appear on several pages. A page shows a zone with the zone’s key; the slug names it in the dashboard and the API. | Home – top (slug home-top) |
| Display was frame | How a zone looks: a Stories bar or a Banner, plus its settings. Exactly one per zone, and you can change it at any time. | Bar, circles, medium |
| Template | A starting preset you pick when you create a zone: Stories bar, Promo banner or Blank. It sets the display once; nothing links the zone to it afterwards. | Stories bar |
| Tale group | A set of tales shown as one item: one circle in a bar or one slide in a banner. It can show in several zones, and has one On / Off switch. | Summer sale |
| Tale | One full-screen page of a group: media plus layers, made in Tale Studio. Each tale is Shown or Hidden. | Opening |
| Theme | Colours, rings and fonts for every zone of the project. A host page can override it for one zone. | – |
| Zone key | The key a host page uses to show one zone (tak_…). One active key per zone; an admin issues it on the zone’s Install tab and it is shown once. It sits in page HTML, so it can show only that zone. | tak_… |
| Site key | The project’s key for server-side or legacy Delivery API calls (tas_…), sent with the zone’s slug as ?zone=. A web page uses a zone key instead, never the site key. | tas_… |
How they fit together
A project has zones and tale groups. Each zone has one display and shows tale groups in an order you set; one tale group can show in several zones. A tale group holds tales. The project's theme styles every zone, and a page shows a zone with that zone's key.
On and Off, Shown and Hidden
- A tale group is On or Off. New groups start Off.
- A tale is Shown or Hidden. New tales start Shown, so turning a group On shows all its tales; hide a tale to leave it out.
- Archive sits in a group's or a tale's ⋯ menu.
- A schedule (also in the ⋯ menu) limits when a group or a tale shows. A chip shows the window, such as "Starts 1 Dec 09:00".
- In Tale Studio, Update tale puts your changes on the site; until then visitors see the version before.
Earlier builds placed zones differently: Stages and zone keys says what changed.