You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/grigson/documentation/README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Grigson source files use the `.chart` extension.
14
14
-**Plain text that resembles output.** The pipe character `|` represents a bar line. Time signatures look like time signatures. Chord names are written as you would write them on a lead sheet.
15
15
-**Left-aligned, ragged right.** Unlike some chord chart tools that stretch rows to fill the page width, grigson renders rows at their natural width. A bar with four beats takes up twice as much space as a bar with two beats. The space a passage occupies on the page reflects how long it lasts in time.
16
16
-**Explicit row layout.** Each line in the source becomes a row in the output. You control the layout by how you arrange your source text.
17
-
-**Simple rhythm.** Grigson does not use a rhythm staff or per-chord duration notation. Rhythmic information is conveyed through beat-slot notation (see below).
17
+
-**Simple rhythm.** Grigson does not use a rhythm staff or per-chord duration notation. Rhythmic information is conveyed through beat-cell notation (see below).
18
18
-**Key per section.** Songs that modulate between sections (e.g. verse in Eb, chorus in Ab) can specify a key for each section independently.
19
19
20
20
---
@@ -244,13 +244,13 @@ Hints are separated from the beat grid. The `Bar` type has an optional `tonality
244
244
245
245
```typescript
246
246
interfaceTonalityHintItem {
247
-
beforeSlotIndex:number; // hint applies from this beat-slot index onward within the bar
247
+
beforeCellIndex:number; // hint applies from this beat-cell index onward within the bar
248
248
key:string; // e.g. "Ab major", "D dorian"; "" = reset to home
249
249
loc?:SourceRange;
250
250
}
251
251
```
252
252
253
-
Tonality hints do not occupy a beat slot — they are a side channel on `Bar`. The `slots` array contains only `ChordSlot` and `DotSlot` entries, as before.
253
+
Tonality hints do not occupy a beat cell — they are a side channel on `Bar`. The `cells` array contains only `ChordCell` and `DotCell` entries, as before.
254
254
255
255
---
256
256
@@ -357,7 +357,7 @@ To use the extension during development, open the `packages/vscode-extension` di
357
357
358
358
## What Grigson Does Not Support (by design)
359
359
360
-
-**Rhythm notation.** There is no staff, no note durations on individual chords, no ties or triplets beyond what beat-slot notation can express.
360
+
-**Rhythm notation.** There is no staff, no note durations on individual chords, no ties or triplets beyond what beat-cell notation can express.
361
361
-**Navigation signs.** Coda, Segno, Da Capo, Dal Segno, and Fine are not supported in v1. Use repeat barlines and volta brackets instead, or write the song out in full.
362
362
-**Lyrics.** Grigson is a chord chart tool, not a lead sheet tool.
363
363
-**Auto-reflow.** Row layout is always controlled explicitly by the source text.
Copy file name to clipboardExpand all lines: packages/grigson/documentation/cli.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -351,11 +351,11 @@ The error points to the exact position in the input (`line:character`).
351
351
352
352
#### Semantic warning — beat balance
353
353
354
-
Parse errors catch syntax problems; semantic warnings catch musical logic errors that the parser accepts. A bar with dot slots must have exactly as many slots as the time signature's numerator:
354
+
Parse errors catch syntax problems; semantic warnings catch musical logic errors that the parser accepts. A bar with dot cells must have exactly as many cells as the time signature's numerator:
355
355
356
356
```sh
357
357
$ echo'| (4/4) C . . G . |'| grigson validate
358
-
<stdin>:1:3: warning: Bar has 5 slots but time signature is 4/4 (expected 4)
358
+
<stdin>:1:3: warning: Bar has 5 cells but time signature is 4/4 (expected 4)
The output is unstyled markup. It can be piped into a file and served alongside the grigson stylesheet, or it can be passed through a normalise/transpose step first:
Tonality hints appear as `TonalityHintItem` entries on `Bar.tonalityHints`. The `beforeSlotIndex` field records which chord slot in the bar the hint precedes, enabling correct key-region splitting.
230
+
Tonality hints appear as `TonalityHintItem` entries on `Bar.tonalityHints`. The `beforeCellIndex` field records which chord cell in the bar the hint precedes, enabling correct key-region splitting.
231
231
232
232
```
233
233
{Ab major} C Am | F G
234
234
↑
235
-
hint before slot 0 → C and Am analysed in Ab major
235
+
hint before cell 0 → C and Am analysed in Ab major
236
236
F and G (next bar, no hint) → same Ab major region continues
0 commit comments