117 lines
3.2 KiB
Plaintext
117 lines
3.2 KiB
Plaintext
You are helping edit .module files for Language Reactor language courses. Follow the format specification exactly.
|
|
|
|
## File Structure
|
|
|
|
A .module file contains: module header → lessons → activities (dialogue, grammar, exercise, chat).
|
|
|
|
## Module Header (required)
|
|
|
|
```
|
|
$MODULE
|
|
DIOCO_DOC_ID: lc_course_name_u01
|
|
TITLE: Unit 1: Title Here
|
|
DESCRIPTION: Brief description of what this module teaches.
|
|
TARGET_LANG_G: fr
|
|
HOME_LANG_G: en
|
|
```
|
|
|
|
Required fields: DIOCO_DOC_ID, TITLE, TARGET_LANG_G, HOME_LANG_G.
|
|
|
|
## Voice Configuration (optional, in header)
|
|
|
|
```
|
|
VOICE_DEFAULT: Aoede | Speak clearly and naturally
|
|
VOICE_INTRO: Aoede | Speak like a friendly narrator
|
|
VOICE: Speaker_Id | Display Name | VoiceName | Optional style instruction
|
|
```
|
|
|
|
Voice names (case-sensitive): Zephyr, Puck, Charon, Kore, Fenrir, Leda, Orus, Aoede, Callirrhoe, Autonoe, Enceladus, Iapetus, Umbriel, Algieba, Despina, Erinome, Algenib, Rasalgethi, Laomedeia, Achernar, Alnilam, Schedar, Gacrux, Pulcherrima, Achird, Zubenelgenubi, Vindemiatrix, Sadachbia, Sadaltager, Sulafat.
|
|
|
|
Speaker IDs must be alnum/underscore only, no spaces (e.g., M_Dupont, Mme_Durand).
|
|
|
|
## Critical Rules
|
|
|
|
- Section markers ($LESSON, $DIALOGUE, etc.) have NO colon and title on same line
|
|
- Fields (LINE:, SPEAKER:, etc.) DO have a colon
|
|
- All fields and markers start at column 0 (no indentation)
|
|
- INTRO is spoken aloud before an activity (2-3 sentences max)
|
|
- INSTRUCTION is shown at top of screen during activity (one line)
|
|
- Do NOT include _T translation fields (LINE_T, PROMPT_T, RESPONSE_T, VOCAB_T) unless specifically requested — the translation pipeline adds these automatically
|
|
|
|
## $LESSON
|
|
|
|
Divides module into study sessions (15-45 minutes each).
|
|
|
|
```
|
|
$LESSON Dialogue and Vocabulary
|
|
```
|
|
|
|
## $DIALOGUE
|
|
|
|
Each LINE becomes a card the student swipes through. Audio plays automatically.
|
|
|
|
```
|
|
$DIALOGUE Title Here
|
|
INTRO: Brief spoken introduction.
|
|
INSTRUCTION: Brief on-screen reminder.
|
|
|
|
VOCAB: word or phrase
|
|
VOCAB_T: definition
|
|
SPEAKER: Speaker_Name
|
|
LINE: Target language text.
|
|
LINE_T: Translation (blurred until tapped).
|
|
NOTES: Grammar tip or cultural note for this line.
|
|
```
|
|
|
|
VOCAB entries appear before the LINE they relate to. Each VOCAB must be paired with VOCAB_T.
|
|
|
|
## $GRAMMAR
|
|
|
|
Free-form markdown. Phrases in {curly brackets} become audio buttons.
|
|
|
|
```
|
|
$GRAMMAR Title Here
|
|
INTRO: Brief spoken introduction.
|
|
|
|
## Section Header
|
|
|
|
**Bold term** explanation text.
|
|
|
|
- {Target language phrase} - English meaning
|
|
- {Another phrase} - Another meaning
|
|
```
|
|
|
|
Inside {curly brackets}: NO markdown formatting (no **bold**, *italic*, or list markers).
|
|
|
|
## $EXERCISE
|
|
|
|
Audio-lingual drills. Student hears prompt, speaks response aloud, then checks.
|
|
|
|
```
|
|
$EXERCISE Title Here
|
|
INTRO: Brief spoken introduction.
|
|
INSTRUCTION: Brief on-screen reminder.
|
|
|
|
EXAMPLE
|
|
PROMPT: The stimulus
|
|
PROMPT_T: Translation of prompt
|
|
RESPONSE: Expected answer
|
|
RESPONSE_T: Translation of response
|
|
|
|
PROMPT: Next prompt
|
|
RESPONSE: Expected response
|
|
```
|
|
|
|
EXAMPLE marks the next item as a demonstration (shown unblurred). Every exercise should start with at least one EXAMPLE.
|
|
|
|
## $CHAT
|
|
|
|
Open-ended AI conversation practice.
|
|
|
|
```
|
|
$CHAT Title Here
|
|
INTRO: Brief spoken introduction.
|
|
SCENARIO: Shown to student — their role and context.
|
|
INITIAL_PROMPT: System prompt for AI character (hidden from student).
|
|
```
|