GloST Documentation
Current Version: v0.5.0
GloST (Glossed Syntax Tree) is a framework for processing multilingual text with language learning annotations using a unified/remark-style plugin system.
Quick Links
Getting Started
Core Guides
- Processor API - Unified-style processor with fluent
.use()API - Plugin Registry - Discovery, validation, and conflict detection
- Creating Documents - Build GloST documents
- Using Plugins - Process with plugins
- Custom Plugins - Create your own plugins
Language Implementation
- Implementing Language Providers - Complete provider infrastructure guide
- Multi-Language Architecture - Language support patterns
- Implementing Transcription Providers - Provider patterns
- Creating Data Source Packages - Package creation
- Thai Guide - Thai-specific features
- Japanese Guide - Japanese-specific features
Package Reference
Main Package
| Package | Description |
|---|---|
| glost | Main entry point combining all GLOST functionality |
Foundation Packages
| Package | Description |
|---|---|
| glost-core | Core types, nodes, validators, and tree utilities |
| glost-common | Language utilities and shared code |
| glost-plugins | Plugin architecture and extension system |
| glost-utils | Text manipulation utilities |
Processing Infrastructure
| Package | Description |
|---|---|
| glost-processor | Unified-style processor API |
| glost-registry | Plugin discovery and validation |
| glost-presets | Pre-configured plugin combinations |
| glost-cli | CLI tools |
Language Packages
| Package | Description |
|---|---|
| glost-th | Thai language support |
| glost-ja | Japanese language support |
| glost-ko | Korean language support |
| glost-en | English language support |
Plugin Packages
| Package | Description |
|---|---|
| glost-transcription | Phonetic transcription |
| glost-translation | Text translation |
| glost-frequency | Word frequency |
| glost-difficulty | Difficulty scoring |
| glost-pos | Part-of-speech tagging |
| glost-gender | Grammatical gender |
| glost-clause-segmenter | Clause segmentation |
| glost-inkle | Ink/Inkle integration |
Interface Packages
| Package | Description |
|---|---|
| glost-react | React components for rendering |
| glost-dialogue | Dialogue syntax and helpers |
Core Concepts
- Node Types - Understanding GloST’s node hierarchy
- Plugins - Plugin system architecture
Standards & Reference
- API Reference - Complete API documentation
- Language Codes - ISO-639-1, ISO-639-3, BCP-47
- Proficiency Levels - CEFR, JLPT, HSK, TOPIK mappings
- Metadata Schema - Standard metadata structure
- Naming Conventions - Package naming patterns
Architecture & Philosophy
- Architecture Summary - SRP/SSOT principles and composable design
- Ecosystem Overview - Package ecosystem and relationships
- Package Refactoring - v0.5.0 package structure changes
- Unified Pipeline Implementation - v0.5.0 technical details
- Provider Philosophy - “No Data > Bad Data” principle
Examples
- Examples Index - Browse all examples
- Ruby Annotations - Displaying with furigana
- Progressive Display - Reveal levels
- Multi-Language - Multiple languages
- Dialogues - Conversation structures
Version History
- v0.5.0 (Current) - Release Notes - Unified-style processor, enhanced registry, CLI tools, presets
- v0.4.0 - Extension system, multi-language support
- v0.3.0 - Core types and document creation
Quick Example
import { glost } from '@glotblocks/glost';
import { languageLearningPreset } from '@glotblocks/glost/presets';
import { createThaiWord, createSimpleDocument } from '@glotblocks/glost';
// Create processor with preset
const processor = glost()
.use(languageLearningPreset)
.freeze();
// Create document
const document = createSimpleDocument(
[
createThaiWord({ text: "สวัสดี" }),
createThaiWord({ text: "ครับ" })
],
"th",
"thai",
{ sentenceText: "สวัสดีครับ" }
);
// Process
const result = await processor.process(document);Support
Last updated on