From 554b1f1803ade9ae488b65387dfdeb8b4f7b4ebd Mon Sep 17 00:00:00 2001 From: Juan Cobo Betancourt Date: Wed, 10 Jun 2026 23:04:38 -0700 Subject: [PATCH] Document glossary links in story step text and case-insensitive matching (v1.5.1) Note that [[term]] resolves in a story step's answer text, not only in layer panels, and that term matching is case-insensitive. Bump documented version to 1.5.1. --- CHANGELOG.md | 6 ++++++ _config.yml | 4 ++-- docs/6-2-glossary.es.md | 8 +++++++- docs/6-2-glossary.md | 8 +++++++- 4 files changed, 22 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1e361dd..bbffc4d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,12 @@ All notable changes to Telar Documentation will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). +## [1.5.1] - 2026-06-10 + +### Changed +- Documented that glossary `[[term]]` links work in a story step's answer text, not only in layer panels, and that term matching is case-insensitive. +- Updated documented version to v1.5.1. + ## [1.5.0] - 2026-06-06 ### Added diff --git a/_config.yml b/_config.yml index 11fbbed..696569a 100644 --- a/_config.yml +++ b/_config.yml @@ -66,8 +66,8 @@ callouts: color: yellow # Telar framework version (used across the docs site) -telar_version: "1.5.0" -telar_release_date: "2026-05-26" +telar_version: "1.5.1" +telar_release_date: "2026-06-10" # Build settings markdown: kramdown diff --git a/docs/6-2-glossary.es.md b/docs/6-2-glossary.es.md index 0779db8..6bb7319 100644 --- a/docs/6-2-glossary.es.md +++ b/docs/6-2-glossary.es.md @@ -58,7 +58,7 @@ Cada archivo define un término. El cuerpo del archivo es la definición. ## Enlazar a términos del glosario -Enlaza a términos del glosario desde los paneles de las historias usando sintaxis de doble corchete: +Enlaza a términos del glosario desde el texto y los paneles de tus historias usando sintaxis de doble corchete: ### Forma abreviada @@ -84,11 +84,17 @@ Se renderiza como: El dispositivo de tejido era central para la producci Los autoenlaces de glosario funcionan en: +- Texto del paso — la **respuesta** de un paso (el texto principal que se desplaza) - Contenido de paneles de historias (los tres métodos: texto directo, markdown pegado, archivos) - Páginas personalizadas +La **pregunta** del paso es un encabezado, así que los enlaces de glosario ahí se dejan como texto plano a propósito. + Si un `term_id` no se encuentra en el glosario, un ícono de advertencia y un mensaje de error aparecen en la salida de la *build* y en el panel de la historia. +{: .note } +> Los términos se reconocen sin distinción de mayúsculas. `[[loom]]`, `[[Loom]]` y `[[LOOM]]` resuelven a la misma entrada, así que puedes escribir un término como mejor se lea —por ejemplo, una sigla como `[[IIIF]]`. + ## Experiencia de visualización Cuando alguien hace clic en un enlace de glosario: diff --git a/docs/6-2-glossary.md b/docs/6-2-glossary.md index 6837d0a..67a21bd 100644 --- a/docs/6-2-glossary.md +++ b/docs/6-2-glossary.md @@ -58,7 +58,7 @@ Each file defines one term. The body of the file is the definition. ## Linking to Glossary Terms -Link to glossary terms from story panels using double-bracket syntax: +Link to glossary terms from your story text and panels using double-bracket syntax: ### Shorthand @@ -84,11 +84,17 @@ Renders as: The weaving device was central to textile production. Glossary auto-links work in: +- Story step text — the **answer** of a story step (the main scrolling prose) - Story panel content (all three methods: direct text, pasted markdown, file references) - Custom pages +The step **question** is a heading, so glossary links there are intentionally left as plain text. + If a `term_id` is not found in the glossary, a warning icon and error message appear in the build output and in the story panel. +{: .note } +> Term matching is case-insensitive. `[[loom]]`, `[[Loom]]`, and `[[LOOM]]` all resolve to the same entry, so you can write a term however reads best — for example an acronym as `[[IIIF]]`. + ## Viewer Experience When a viewer clicks a glossary link: