Skip to content

Commit ef5dd62

Browse files
committed
remove rsvp as not related
1 parent 8d9701b commit ef5dd62

File tree

1 file changed

+13
-42
lines changed

1 file changed

+13
-42
lines changed

README.md

Lines changed: 13 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ TPS bridges this gap: it is human-readable markdown that any text editor can ope
2121
1. **Markdown-compatible** — a `.tps` file renders reasonably in any markdown viewer.
2222
2. **Human-authorable** — no tooling required to write a valid script.
2323
3. **Hierarchical** — documents decompose into Segments → Blocks → Phrases → Words, each level inheriting and overriding properties.
24-
4. **Profile-aware** — the same format serves both natural Actor reading and rapid RSVP (Rapid Serial Visual Presentation) display.
25-
5. **Minimal yet extensible** — the core tag set is small; parsers ignore unknown tags gracefully.
24+
4. **Minimal yet extensible** — the core tag set is small; parsers ignore unknown tags gracefully.
2625

2726
## Glossary
2827

@@ -35,7 +34,6 @@ TPS bridges this gap: it is human-readable markdown that any text editor can ope
3534
| **Phrase** | A sentence or thought within a block, delimited by sentence-ending punctuation or pause markers. |
3635
| **Word** | An individual token with optional per-word properties (color, emphasis, pause). |
3736
| **WPM** | Words Per Minute — the reading speed. |
38-
| **ORP** | Optimal Recognition Point — the character position in a word where the eye focuses (used in RSVP mode). |
3937
| **Edit Point** | A marker indicating a natural place to stop or start an editing session. |
4038
| **Emotion** | A predefined mood preset that controls visual styling (colors) and presentation hints. |
4139

@@ -60,7 +58,7 @@ The front matter is a YAML block delimited by `---` lines at the very start of t
6058
```yaml
6159
---
6260
title: "Script Title"
63-
profile: Actor # Actor (default) | RSVP
61+
profile: Actor # Actor (default)
6462
duration: "10:00" # Target duration MM:SS
6563
base_wpm: 140 # Default words per minute
6664
speed_offsets: # Percentage offsets for speed tags relative to base_wpm
@@ -77,9 +75,9 @@ version: "1.0"
7775
| Field | Type | Default | Description |
7876
|-------|------|---------|-------------|
7977
| `title` | string || Human-readable script title. |
80-
| `profile` | string | `Actor` | `Actor` for natural reading, `RSVP` for rapid visual display. |
78+
| `profile` | string | `Actor` | `Actor` for natural spoken reading from a teleprompter. |
8179
| `duration` | string || Target duration in `MM:SS` format. |
82-
| `base_wpm` | integer | 140 (Actor) / 300 (RSVP) | Default reading speed for the entire document. |
80+
| `base_wpm` | integer | 140 | Default reading speed (words per minute) for the entire document. |
8381
| `speed_offsets.xslow` | integer | -40 | Percentage offset for `[xslow]...[/xslow]` tags. Default -40 means 60% of base speed. |
8482
| `speed_offsets.slow` | integer | -20 | Percentage offset for `[slow]...[/slow]` tags. Default -20 means 80% of base speed. |
8583
| `speed_offsets.fast` | integer | 25 | Percentage offset for `[fast]...[/fast]` tags. Default 25 means 125% of base speed. |
@@ -314,7 +312,7 @@ All speed presets are **relative to base_wpm** — they apply a multiplier, not
314312

315313
Properties flow downward through the hierarchy. Each level can override its parent:
316314

317-
1. **Front matter** sets document-level defaults (base_wpm, profile, speed_offsets).
315+
1. **Front matter** sets document-level defaults (base_wpm, speed_offsets).
318316
2. **Segment** overrides document defaults for WPM, emotion.
319317
3. **Block** overrides segment defaults for WPM, emotion.
320318
4. **Inline tags** override block defaults for the tagged span only.
@@ -329,7 +327,7 @@ For any word, the effective WPM is determined by (highest priority first):
329327
2. Block header WPM
330328
3. Segment header WPM
331329
4. `base_wpm` from front matter
332-
5. Profile default (Actor: 140, RSVP: 300)
330+
5. Default: 140 WPM
333331

334332
### Pause Handling
335333

@@ -369,10 +367,6 @@ TPS is designed for **teleprompter use** — text is always rendered on a **dark
369367
4. **Emotion color schemes** (background, text, accent) are pre-defined per emotion. They are not raw hex values — they are tuned for the dark rendering context with appropriate alpha channels.
370368
5. **`highlight`** uses a semi-transparent yellow background overlay, not a text color change.
371369

372-
### ORP Display (RSVP Mode)
373-
374-
In RSVP mode, the current word is displayed large and centered with the **Optimal Recognition Point** (ORP) character highlighted in a contrasting color (typically the segment's accent color). Surrounding context words appear smaller and dimmer.
375-
376370
## WPM Guidelines
377371

378372
### Actor Profile (Spoken Reading)
@@ -396,40 +390,17 @@ The Actor profile targets natural spoken delivery — reading aloud from a telep
396390
- Use `[xfast]...[/xfast]` for rapid transitions or low-importance filler.
397391
- Add `/` pauses between clauses; `//` between sentences.
398392

399-
### RSVP Profile (Visual Reading)
400-
401-
RSVP displays one word at a time at high speed — used for speed-reading practice and silent content consumption.
402-
403-
| Use Case | WPM Range | Recommendation |
404-
|----------|-----------|----------------|
405-
| Beginner RSVP reader | 200–280 | Comfortable starting point |
406-
| **Standard RSVP** | **280–400** | **Trained RSVP reader** |
407-
| Fast RSVP | 400–500 | Experienced user |
408-
| Expert RSVP | 500–600 | Maximum useful speed |
409-
410-
**Default `base_wpm`: 300** — comfortable for most RSVP-trained users.
411-
412393
## Profiles and Validation
413394

414-
### Profiles
415-
416-
- **Actor** (default): natural spoken reading.
417-
- base_wpm default: 140
418-
- Allowed WPM: 90–200 (Recommended: 130–160)
419-
- Segment/Block headers: single WPM value only
420-
- **RSVP**: rapid serial visual presentation (visual reading).
421-
- base_wpm default: 300
422-
- Allowed WPM: 150–600 (Recommended: 280–400)
423-
- Segment/Block headers: single integer WPM
424-
425395
### Validation Requirements
426396

427-
| Rule | Actor | RSVP |
428-
|------|-------|------|
429-
| WPM error range | < 80 or > 220 | < 150 or > 600 |
430-
| WPM warning range | < 90 or > 200 | < 200 or > 500 |
431-
| Segment/Block WPM | Single integer | Single integer |
432-
| Inline speed | Integer, respects profile range | Integer, respects profile range |
397+
| Rule | Value |
398+
|------|-------|
399+
| WPM error range | < 80 or > 220 |
400+
| WPM warning range | < 90 or > 200 |
401+
| Recommended WPM | 130–160 |
402+
| Segment/Block WPM | Single integer |
403+
| Inline speed | Integer, respects allowed range |
433404

434405
Additional validation:
435406
- Emotions must be from the predefined set (see table above).

0 commit comments

Comments
 (0)