mirror of
https://github.com/JimLiu/baoyu-skills.git
synced 2026-07-21 01:39:48 +08:00
Jim Liu 宝玉
5771e6d8c5
Support glossary_files in EXTEND.md for loading glossaries from external markdown tables or YAML files. Add frontmatter transformation rules to rename source metadata fields with source prefix during translation.
108 lines
3.4 KiB
Markdown
108 lines
3.4 KiB
Markdown
# EXTEND.md Schema for baoyu-translate
|
|
|
|
## Format
|
|
|
|
EXTEND.md uses YAML format:
|
|
|
|
```yaml
|
|
# Default target language (ISO code or common name)
|
|
target_language: zh-CN
|
|
|
|
# Default translation mode
|
|
default_mode: normal # quick | normal | refined
|
|
|
|
# Target audience (affects annotation depth and register)
|
|
audience: general # general | technical | academic | business | or custom string
|
|
|
|
# Translation style preference
|
|
style: storytelling # storytelling | formal | technical | literal | academic | business | humorous | conversational | elegant | or custom string
|
|
|
|
# Word count threshold to trigger chunked translation
|
|
chunk_threshold: 4000
|
|
|
|
# Max words per chunk
|
|
chunk_max_words: 5000
|
|
|
|
# Custom glossary (merged with built-in glossary)
|
|
# CLI --glossary flag overrides these
|
|
# Supports inline entries and/or file paths
|
|
glossary:
|
|
- from: "Reinforcement Learning"
|
|
to: "强化学习"
|
|
- from: "Transformer"
|
|
to: "Transformer"
|
|
note: "Keep English"
|
|
|
|
# Load glossary from external file(s)
|
|
# Supports absolute path or relative to EXTEND.md location
|
|
# File format: markdown table with | from | to | note | columns,
|
|
# or YAML list of {from, to, note} entries
|
|
glossary_files:
|
|
- ./my-glossary.md
|
|
- /path/to/shared-glossary.yaml
|
|
|
|
# Language-pair specific glossaries
|
|
glossaries:
|
|
en-zh:
|
|
- from: "AI Agent"
|
|
to: "AI 智能体"
|
|
ja-zh:
|
|
- from: "人工知能"
|
|
to: "人工智能"
|
|
```
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Default | Description |
|
|
|-------|------|---------|-------------|
|
|
| `target_language` | string | `zh-CN` | Default target language code |
|
|
| `default_mode` | string | `normal` | Default translation mode (`quick` / `normal` / `refined`) |
|
|
| `audience` | string | `general` | Target reader profile (`general` / `technical` / `academic` / `business` / custom) |
|
|
| `style` | string | `storytelling` | Translation style (`storytelling` / `formal` / `technical` / `literal` / `academic` / `business` / `humorous` / `conversational` / `elegant` / custom) |
|
|
| `chunk_threshold` | number | `4000` | Word count threshold to trigger chunked translation |
|
|
| `chunk_max_words` | number | `5000` | Max words per chunk |
|
|
| `glossary` | array | `[]` | Universal glossary entries (inline) |
|
|
| `glossary_files` | array | `[]` | External glossary file paths (absolute or relative to EXTEND.md) |
|
|
| `glossaries` | object | `{}` | Language-pair specific glossary entries |
|
|
|
|
## Glossary Entry
|
|
|
|
| Field | Required | Description |
|
|
|-------|----------|-------------|
|
|
| `from` | yes | Source term |
|
|
| `to` | yes | Target translation |
|
|
| `note` | no | Usage note (e.g., "Keep English", "Only in tech context") |
|
|
|
|
## Glossary File Format
|
|
|
|
External glossary files (`glossary_files`) support two formats:
|
|
|
|
**Markdown table** (`.md`):
|
|
```markdown
|
|
| from | to | note |
|
|
|------|----|------|
|
|
| Reinforcement Learning | 强化学习 | |
|
|
| Transformer | Transformer | Keep English |
|
|
```
|
|
|
|
**YAML list** (`.yaml` / `.yml`):
|
|
```yaml
|
|
- from: "Reinforcement Learning"
|
|
to: "强化学习"
|
|
- from: "Transformer"
|
|
to: "Transformer"
|
|
note: "Keep English"
|
|
```
|
|
|
|
Paths can be absolute or relative to the EXTEND.md file location.
|
|
|
|
## Priority
|
|
|
|
1. CLI `--glossary` file entries
|
|
2. EXTEND.md `glossaries[pair]` entries
|
|
3. EXTEND.md `glossary` entries (inline)
|
|
4. EXTEND.md `glossary_files` entries (in listed order, later files override earlier)
|
|
5. Built-in glossary (e.g., `references/glossary-en-zh.md`)
|
|
|
|
Later entries override earlier ones for the same source term.
|