Skip to content

Commit da49655

Browse files
Danielku15Danielku15
authored
docs: Documentation for 1.4.0 (#113)
2 parents 767d3f4 + ebfdc9c commit da49655

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+3186
-231
lines changed

‎docs/alphatex/bar-metadata.mdx‎

Lines changed: 112 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ mix the score metadata and the bar metadata of the first bar.
1111

1212
## Time Signatures
1313

14-
Time signatures have the format `\ts Numerator Denominator`.
14+
Time signatures have the format `\ts Numerator Denominator` or `\ts common`
1515

1616
<AlphaTexSample>{`
17-
\\ts 3 4 | \\ts 4 4 | \\ts 6 8
17+
\\ts 3 4 | \\ts 4 4 | \\ts 6 8 | \\ts common
1818
`}</AlphaTexSample>
1919

20+
2021
## Repeats
2122

2223
Repeats can be started with `\ro` and
@@ -50,16 +51,25 @@ A major scale can also be explicitly written out, like `Dmajor`.
5051
\\ks Aminor | \\ks Dmajor | \\ks Bminor
5152
`}</AlphaTexSample>
5253

54+
The type of key signatures (major or minor) is derived from the used name.
55+
5356
## Clef
5457

5558
To change the clef simply specify `\clef Clef` where Clef is one of the following
5659
values: `G2, Treble, F4, Bass, C3, Tenor, C4, Alto, N, Neutral`
5760

61+
To add ottavia to the clef add `\ottava Ottava` where Ottava is one of the following
62+
values: `15ma`, `8va`, `regular`, `8vb`, `15mb`.
63+
64+
Clefs are remembered across bars unless explicitly changed.
65+
5866
<AlphaTexSample>{`
5967
\\clef G2 | \\clef F4 | \\clef C3 | \\clef C4 | \\clef N |
60-
\\clef Treble | \\clef Bass | \\clef Tenor | \\clef Alto | \\clef Neutral
68+
\\clef Treble | \\clef Bass | \\clef Tenor | \\clef Alto | \\clef Neutral |
69+
\\clef F4 \\ottava 15ma | | \\ottava regular | | \\clef C3 \\ottava 8vb | |
6170
`}</AlphaTexSample>
6271

72+
6373
## Tempo
6474

6575
To change the tempo of the score you can specify `\tempo BPM`.
@@ -120,3 +130,102 @@ If you want to also specify a marker beside the text, use the format `\section M
120130
\\section S Solo // with marker and section name differently
121131
1.1 1.1 1.1 1.1
122132
`}</AlphaTexSample>
133+
134+
## Directions
135+
136+
To specify play directions (jumps and jump targets) use the `\jump` metadata followed by the respective instruction.
137+
The names should be self explaining if you're familiar with this notation:
138+
139+
**Jump Targets**
140+
141+
* `Fine`
142+
* `Segno`
143+
* `SegnoSegno`
144+
* `Coda`
145+
* `DoubleCoda`
146+
147+
**Jump Instructions**
148+
149+
* `DaCapo`
150+
* `DaCapoAlCoda`
151+
* `DaCapoAlDoubleCoda`
152+
* `DaCapoAlFine`
153+
154+
* `DalSegno`
155+
* `DalSegnoAlCoda`
156+
* `DalSegnoAlDoubleCoda`
157+
* `DalSegnoAlFine`
158+
159+
* `DalSegnoSegno`
160+
* `DalSegnoSegnoAlCoda`
161+
* `DalSegnoSegnoAlDoubleCoda`
162+
* `DalSegnoSegnoAlFine`
163+
164+
* `DaCoda`
165+
* `DaDoubleCoda`
166+
167+
<AlphaTexSample player="true">{`
168+
.
169+
\\ro \\rc 2 3.3*4 |
170+
3.3*4 |
171+
\\jump Segno 3.3*4 |
172+
\\ro \\rc 2 3.3*4 |
173+
\\jump DaCoda 3.3*4 |
174+
3.3*4 | 3.3*4
175+
\\jump DalSegnoAlCoda 3.3*4 |
176+
3.3*4 |
177+
\\jump Coda 3.3*4 |
178+
3.3*4 |
179+
3.3*4
180+
`}</AlphaTexSample>
181+
182+
## Free Time
183+
184+
To mark bars as free time bars, add the `\ft` tag to it.
185+
186+
<AlphaTexSample player="true">{`
187+
.
188+
:2
189+
C4*2 |
190+
\\ft C4*2 |
191+
\\ft C4*2 |
192+
C4*2 |
193+
`}</AlphaTexSample>
194+
195+
196+
## Transpose
197+
198+
This metadata affects the whole staff, its recommended to specify this only on the first bar of a staff not later.
199+
200+
* `displayTranspose semitones` - Defines the number of semitones to transpose the notes in this staff with. This only affects the display of the notes, not their audio.
201+
* `transpose semitones` - Defines the number of semitones to transpose the notes in this staff with. This affects the display and audio.
202+
203+
<AlphaTexSample player="true" tracks="all">{`
204+
\\track \\staff \\instrument piano
205+
\\displayTranspose -12
206+
C4.4 D4 E4 F4 | r.1
207+
\\track \\staff \\instrument piano
208+
\\transpose -12
209+
r.1 | C4.4 D4 E4 F4
210+
`}</AlphaTexSample>
211+
212+
## Double Bar
213+
214+
To mark a bar as double bar add `\db`
215+
216+
<AlphaTexSample>{`
217+
\\db 3.3 3.3 3.3 3.3 | 1.1 2.1 3.1 4.1
218+
`}</AlphaTexSample>
219+
220+
## Simile Marks
221+
222+
To apply simile marks use the `\simile type` where type is:
223+
224+
* `none` - No simile mark is applied
225+
* `simple` - A simple simile mark. The previous bar is repeated.
226+
* `firstofdouble` - A double simile mark. This value is assigned to the first bar of the 2 repeat bars.
227+
* `secondofdouble` - A double simile mark. This value is assigned to the second bar of the 2 repeat bars.
228+
229+
<AlphaTexSample player="true">{`
230+
3.3*4 | \\simile simple | 3.3*4 | 4.3*4 | \\simile firstofdouble | \\simile secondofdouble
231+
`}</AlphaTexSample>

‎docs/alphatex/beat-effects.mdx‎

Lines changed: 190 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ Multiple effects are simply separated by spaces, like `3.3{f v}`.
1313
Please find the list of supported effects in the example below.
1414

1515
<AlphaTexSample>{`
16-
// fade in
17-
3.3{f}
18-
// vibrato
19-
3.3{v}
16+
// fade in, fade out and volume swell
17+
3.3{f} 3.3{fo} 3.3{vs} |
18+
// vibrato (slight and wide)
19+
3.3{v} 3.3{vw} |
2020
// tap
2121
3.3{tt}
2222
// slap
@@ -39,9 +39,10 @@ Please find the list of supported effects in the example below.
3939
3.3{gr}
4040
3.3
4141
|
42-
// Tuplets (supported variants: 3, 5, 6, 7, 9, 10, 11, 12)
43-
3.3{tu 3} 3.3{tu 3} 3.3{tu 3}
44-
3.3{tu 5} 3.3{tu 5} 3.3{tu 5} 3.3{tu 5} 3.3{tu 5}
42+
// Tuplets (supported variants: 3, 5, 6, 7, 9, 10, 11, 12 or custom)
43+
3.3{tu 3} 3.3{tu 3} 3.3{tu 3} |
44+
3.3{tu 5} 3.3{tu 5} 3.3{tu 5} 3.3{tu 5} 3.3{tu 5} |
45+
3.3{tu 4 3} 3.3{tu 4 3} 3.3{tu 4 3} 3.3{tu 4 3}
4546
|
4647
// tremolo picking (tp duration - where duration can be 8, 16 or 32)
4748
3.3{tp 8} 3.3{tp 16} 3.3{tp 32}
@@ -74,13 +75,40 @@ To reset the tuplet range, a new duration range can be started. For individual n
7475
The tremolo/whammy bar effect is a bit more complex than the others.
7576
You can specify a number of values which are evenly distributed over the
7677
time when the note is played with the format `tb (value1 value2 ...)`.
77-
The values indicate the number of quarter notes increased or decreased while playing.
78+
The values indicate the number of quarter notes increased or decreased while playing (use decimals for quarter notes).
7879

79-
<AlphaTexSample>{`
80+
<AlphaTexSample player="true">{`
8081
3.3.1{tb (0 4 0 8)} |
8182
3.3.1{tb (0 -4 0 -8)} |
8283
`}</AlphaTexSample>
8384

85+
To specify a whammy with exact positions (not evenly distributed) you can use `tbe (offset1 value1 offset2 value2)`.
86+
The offset is ranging from 0 to 60.
87+
88+
<AlphaTexSample player="true">{`
89+
3.3.1{tbe (0 0 5 4 30 8 60 0)}
90+
`}</AlphaTexSample>
91+
92+
Additionally the exact whammy type and style can be specified for both kinds after before the value list.
93+
94+
* `tb type (value1 value2)`
95+
* `tb type style (value1 value2)`
96+
* `tbe type (value1 value2)`
97+
* `tbe type style (value1 value2)`
98+
99+
It is recommended to rely on the auto-detection of the type and only specify the type explicitly if something is wrong:
100+
* `custom` - use this for non standard custom whammys with multiple points
101+
* `dive` - use this when having a gradual change between two points
102+
* `dip` - use this when you have a A->B->A whammy pattern.
103+
* `hold` - use this when holding whammys (on tied notes)
104+
* `predive` - use this when whammy bar is pressed/pulled before playing the note and then kept.
105+
* `predivedive` - use this when whammy bar is pressed/pulled before playing the note and then released again.
106+
107+
The style can be one of these values:
108+
* `default` - No additional text is shown, the bend offsets and values are respected as specified.
109+
* `gradual` - Will show an additional "grad." on the whammy line. The audio is generated according to the type spread evenly across the play duration.
110+
* `fast` - No additional text is shown. The audio is generated according to the type spread evenly across the fixed duration set via `settings.player.songBookBendDuration`.
111+
84112
## Brushes / Arpeggio
85113

86114
Brush stroke effects are: brush down `bd`, brush up `bu`, arpeggio down `ad`, and arpeggio up `au`.
@@ -155,3 +183,156 @@ To enable the display of timers add a `timer` to the beat effect list.
155183
3.3.4 { timer } 3.3.4*3
156184
`}</AlphaTexSample>
157185

186+
## Tempo Changes
187+
188+
With the support of multiple tempo changes within a single bar, tempo changes can now be applied on beat level to mark
189+
the exact spot when the tempo should be changed.
190+
191+
<AlphaTexSample>{`
192+
.
193+
C4 {tempo 120} D4 E4 {tempo 140} F4 | C4.8 {tempo 80} C4 D4 {tempo 100} D4 E4 {tempo 120} E4 F4 {tempo 240} F4
194+
`}</AlphaTexSample>
195+
196+
## Rasgueado
197+
198+
Rasgueado patterns can be added to beats via `rasg PATTERN` where pattern is one of the following values dervived from the patterns
199+
Guitar Pro supports:
200+
201+
import { RasgueadoPatterns } from '@site/src/components/RasgueadoPatterns';
202+
203+
<RasgueadoPatterns />
204+
205+
<AlphaTexSample player="true">{`
206+
(1.1 3.2 2.3 0.4) * 4 {rasg amii}
207+
`}</AlphaTexSample>
208+
209+
## Slashed Beats
210+
211+
To use slash notation on beats add the `slashed` keyword to the effect list.
212+
213+
<AlphaTexSample>{`
214+
C4.4 {slashed} C4.8 {slashed} C4.8 {slashed} C4.4 {slashed}
215+
`}</AlphaTexSample>
216+
217+
## Dead Slap
218+
219+
To use dead slapped beats the `ds` keyword to the effect list. As no notes should be on such a beat,
220+
simply use `()` to indicate the empty beat.
221+
222+
<AlphaTexSample>{`
223+
().4 {ds} ().4 {ds}
224+
`}</AlphaTexSample>
225+
226+
## Beat Timer
227+
228+
To show the time when a beat is played the first time add `timer` to the effect list.
229+
230+
<AlphaTexSample>{`
231+
:2 C4 { timer } C4 |
232+
\\ro C4 { timer } C4 |
233+
\\ae 1 C4 C4 { timer } |
234+
\\rc 3 \\ae (2 3) C4 { timer } C4 { timer } |
235+
C4 { timer } C4
236+
`}</AlphaTexSample>
237+
238+
## Sustain Pedals
239+
240+
To mark that on a beat the sustain pedal should be pressed add `spd`.
241+
To release it again `spu`
242+
243+
<AlphaTexSample>{`
244+
3.3{string} 3.3{spd} 3.3 3.3 {spu}
245+
`}</AlphaTexSample>
246+
247+
## Golpe
248+
249+
To mark that on a beat a golpe should be performed with the thumb use `glpt`, to add a golpe played with a finger use `glpf`
250+
251+
<AlphaTexSample>{`
252+
3.3{glpf} 3.3{glpt}
253+
`}</AlphaTexSample>
254+
255+
## Wah-Pedal
256+
257+
To mark that on a beat a wah pedal should be opened `waho`, and indicate a close use `wahc`.
258+
259+
<AlphaTexSample>{`
260+
3.3 3.3{waho} 3.3 3.3 {wahc}
261+
`}</AlphaTexSample>
262+
263+
## Barré
264+
265+
To show barré chord notation, add `barre fret mode` to the effect list where
266+
267+
* `fret` is the numeric fret of the barré chord
268+
* `mode` is either `full` (default if no mode specified) or `half`
269+
270+
<AlphaTexSample>{`
271+
1.1 {barre 24} 2.1 {barre 24} 3.1 {barre 24} 4.1 |
272+
1.1 {barre 4 half} 2.1 {barre 4 half} 3.1 {barre 4 half} 4.1 {barre 4 half} |
273+
`}</AlphaTexSample>
274+
275+
## Ottava
276+
277+
To mark octave changes on beats add `ottava value` to the effect list where value is one of:
278+
279+
* `15ma`
280+
* `8va`
281+
* `regular`
282+
* `8vb`
283+
* `15mb`
284+
285+
<AlphaTexSample>{`
286+
3.3.4{ ot 15ma } 3.3.4{ ot 8vb }
287+
`}</AlphaTexSample>
288+
289+
## Legato
290+
291+
To indicate a beat starts a legato to the next beat mark it with `legatoOrigin`:
292+
293+
<AlphaTexSample>{`
294+
3.3.4{ legatoOrigin } 10.3.4
295+
`}</AlphaTexSample>
296+
297+
## Instrument Changes
298+
299+
To mark a change of the instrument used for playback use the `instrument instrumentNumberOrName` effect.
300+
301+
See [Instrument](/docs/alphatex/metadata#instrument) for details on available instruments.
302+
303+
<AlphaTexSample player="true">{`
304+
\\instrument ElectricGuitarClean
305+
1.1 2.1 3.1 4.1 | 1.1 { instrument DistortionGuitar txt Distortion } 2.1 3.1 4.1
306+
`}</AlphaTexSample>
307+
308+
## Fermata
309+
310+
To mark fermatas add `fermata fermataType` or `fermata fermataType fermataLength` to the beat effects.
311+
* `fermataType` can be `short`, `medium` or `long`
312+
* `fermataLength` is currently ignored.
313+
314+
<AlphaTexSample>{`
315+
G4 G4 G4 { fermata medium 4 }
316+
`}</AlphaTexSample>
317+
318+
## Beaming Modes
319+
320+
The beaming modes allow adjusting allow overriding the default beam placement.
321+
322+
* `beam invert` - Inverts the default stem direction.
323+
* `beam up` - Forces the stem to point upwards.
324+
* `beam down` - Forces the stem to point downwards.
325+
* `beam auto` - Sets the beaming mode to automatic.
326+
* `beam split` - Forces a split of the beam to the next beat (if there would be any)
327+
* `beam merge` - Forces a merge of the beam to the next beat (even if there would be none)
328+
* `beam splitsecondary` - Forces a split of the last bar connecting two beats (if there is any).
329+
330+
<AlphaTexSample>{`
331+
:8 3.3{ beam invert } 3.3 |
332+
3.1{ beam up } 3.1 |
333+
3.6{ beam down } 3.6 |
334+
3.3{ beam auto } 3.3 |
335+
3.3{ beam split } 3.3 |
336+
3.3 3.3 { beam merge } 3.3 3.3 |
337+
3.3.16 {beam splitsecondary} 3.3
338+
`}</AlphaTexSample>

0 commit comments

Comments
 (0)