STXT Tutorial

¿Qué es STXT?

STXT es un lenguaje textual semántico y legible, pensado para representar documentos estructurados de forma simple y procesable por máquinas. Sus reglas básicas permiten nodos inline, bloques de texto literal y namespaces.

Ejemplo: ficha de libro para editoriales

A continuación mostramos un ejemplo práctico y sencillo para describir un libro que pueda usar una editorial: metadatos, capítulos y contenido de muestra.

Book: Ejemplo de libro
	Title: Arquitectura de software moderna
	Authors:
		Author: María Pérez
		Author: Juan García
	ISBN: 978-84-123456-7-8
	Publisher: ACME Editorial
	Published: 2025-10-01
	Summary >>
		Este libro ofrece una visión práctica de patrones y buenas prácticas
		para diseñar sistemas distribuidos y escalables.
	Chapters:
		Chapter: 1
			Title: Introducción a la arquitectura
			Pages: 20
			Content >>
				En este capítulo presentamos conceptos básicos: monolitos, microservicios
				y criterios para elegir una arquitectura adecuada.
		Chapter: 2
			Title: Comunicación entre servicios
			Pages: 30
			Content >>
				Se describen protocolos, mensajería y patrones de integración.

Asociar el documento a un namespace

Podemos asociar la ficha a un namespace para validarla mediante un schema.

Book (@com.acme.book): Ejemplo de libro
	Title: Arquitectura de software moderna
	Authors:
		Author: María Pérez
	ISBN: 978-84-123456-7-8

Schema de ejemplo (simplificado)

Un schema permite definir la forma y los tipos de los nodos de un namespace.

Schema (@stxt.schema): com.acme.book
	Node: Book
		Type: EMPTY
		Childs >>
			(1) Title
			(1) Authors
			(1) ISBN
	Node: Title
		Type: TEXT INLINE
	Node: Authors
		Type: TEXT MULTILINE
	Node: ISBN
		Type: TEXT INLINE
	Node: Chapter
		Type: EMPTY
		Childs >>
			(1) Title
			(?) Pages
			(?) Content

Buenas prácticas

Usa bloques >> para contenido de capítulos o textos multilínea.
Mantén la indentación consistente (4 espacios por nivel) y no mezcles tabs y espacios.
Usa namespaces para separar esquemas por editoriales o colecciones.
Define cardinalidades mínimas en los schemas para garantizar datos clave.

Ejemplo final completo

Book (@com.acme.book): ACME - Arquitectura de software moderna
	Title: Arquitectura de software moderna
	Authors:
		Author: María Pérez
		Author: Juan García
	ISBN: 978-84-123456-7-8
	Chapters:
		Chapter: 1
			Title: Introducción a la arquitectura
			Content >>
				Conceptos básicos y objetivos del libro.

Si quieres, puedo generar a partir de este ejemplo: (a) una conversión a JSON intermedio para procesar automáticamente, (b) un conversor a un formato de catálogo (ISBN/OPDS) o (c) tests de validación frente al schema de ejemplo. ¿Cuál prefieres?

◄ Introducción Documentos STXT ►