Skip to content

Commit 02450c4

Browse files
Danielku15Danielku15
committed
docs: Added docs for multi-bar rests [skip ci]
1 parent f96b1e7 commit 02450c4

File tree

5 files changed

+114
-11
lines changed

5 files changed

+114
-11
lines changed

‎docs/alphatex/stylesheet.mdx‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,31 @@ To configure the mode how to show [track names](/docs/showcase/general.mdx#track
116116
C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 | C4 D4 E4 F4 |
117117
`}</AlphaTexSample>
118118

119+
## Multi-Bar Rests
120+
121+
To configure whether [multibar rests](/docs/showcase/layouts.mdx#multi-bar-rests) should be enabled use:
122+
123+
* `\multiBarRest` - On top level for configuring the use on multi-track renderings
124+
* `\track { multiBarRest }` - On track level for single track renderings
125+
126+
<AlphaTexSample tracks="all">{`
127+
\\title "Multi Track"
128+
\\multiBarRest
129+
.
130+
\\track "Piano 1" "pno1"
131+
\\staff {score}
132+
C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | C4
133+
134+
\\track "Piano 2" "pno1"
135+
\\staff {score}
136+
C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | r |
137+
`}</AlphaTexSample>
138+
139+
<AlphaTexSample tracks="all">{`
140+
\\title "Single Track"
141+
.
142+
\\track "Piano 1" "pno1" { multiBarRest }
143+
\\staff {score}
144+
C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | C4
145+
`}</AlphaTexSample>
146+

‎docs/formats/guitar-pro-7.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -338,11 +338,11 @@ import { FileFormatFeatureTable, FileFormatFeatureGroup, FileFormatFeatureRow, F
338338
tex={[FeatureStatus.Supported]} />
339339

340340
<FileFormatFeatureRow feature="Multirest" isNewFeature="true"
341-
model={[FeatureStatus.NotSupported]}
342-
reading={[FeatureStatus.NotSupported]}
343-
render={[FeatureStatus.NotSupported]}
344-
audio={[FeatureStatus.Ignored]}
345-
tex={[FeatureStatus.NotSupported]} />
341+
model={[FeatureStatus.Supported]}
342+
reading={[FeatureStatus.Supported]}
343+
render={[FeatureStatus.Supported]}
344+
audio={[FeatureStatus.Supported]}
345+
tex={[FeatureStatus.Supported]} />
346346

347347
</FileFormatFeatureGroup>
348348
<FileFormatFeatureGroup title="Beat Level">

‎docs/formats/guitar-pro-8.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -350,11 +350,11 @@ import { FileFormatFeatureTable, FileFormatFeatureGroup, FileFormatFeatureRow, F
350350
tex={[FeatureStatus.Supported]} />
351351

352352
<FileFormatFeatureRow feature="Multirest"
353-
model={[FeatureStatus.NotSupported]}
354-
reading={[FeatureStatus.NotSupported]}
355-
render={[FeatureStatus.NotSupported]}
356-
audio={[FeatureStatus.Ignored]}
357-
tex={[FeatureStatus.NotSupported]} />
353+
model={[FeatureStatus.Supported]}
354+
reading={[FeatureStatus.Supported]}
355+
render={[FeatureStatus.Supported]}
356+
audio={[FeatureStatus.Supported]}
357+
tex={[FeatureStatus.Supported]} />
358358

359359
</FileFormatFeatureGroup>
360360
<FileFormatFeatureGroup title="Beat Level">

‎docs/releases/release1_5.mdx‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: v1.5
3+
---
4+
5+
import { AlphaTab } from '@site/src/components/AlphaTab/';
6+
7+
## 1.5.0
8+
9+
:::info
10+
alphaTab 1.5.0 is still work-in-progress and only available as pre-release version. This document collects already newly
11+
added features.
12+
:::
13+
14+
### Music Notation
15+
16+
#### rendering: Multi-Bar Rests
17+
https://github.com/CoderLine/alphaTab/pull/1934
18+
19+
We added support for merging rests spanning multi-bars together (aka. multi.bar rests).
20+
Supported for alphaTex and Guitar Pro.
21+
22+
<AlphaTab tex={true} tracks="all" player={true}>{`
23+
\\multiBarRest
24+
.
25+
\\track "Piano 1" "pno1"
26+
\\staff {score}
27+
C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | C4
28+
29+
\\track "Piano 2" "pno1"
30+
\\staff {score}
31+
C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | r |
32+
`}</AlphaTab>
33+
34+
### Player
35+
36+
### alphaTex Extensions
37+
38+
### Guitar Pro Extensions
39+
40+
### MusicXML Extensions
41+
42+
### Improvements & Bugfixes
43+
44+
#### player: Broken Cursor Display for repeats
45+
https://github.com/CoderLine/alphaTab/pull/1934
46+
47+
On repeats the bar cursor could behave rather strange moving back to the repeat start instead of transitioning to the end of the bar to the repeat end sign.
48+
With this fix the beat cursor should correctly move again in such scenarios.
49+
50+
#### player: Wrong beat cursor placement when scaling score
51+
https://github.com/CoderLine/alphaTab/pull/1934
52+
53+
When drawing scores at non 100%, the beat cursor was placed wrongly.

‎docs/showcase/layouts.mdx‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,26 @@ You can also filter the rendered bars using this layout.
6969
startBar: 5,
7070
barCount: 4
7171
}
72-
} } />
72+
} } />
73+
74+
75+
## Multi-Bar Rests
76+
77+
alphaTab can load the information whether Multi-Bar rests should be used from input files and then merge the bars when displaying accordingly.
78+
The bars are automatically merged if they are empty or contain only rests.
79+
80+
For Guitar Pro files the format is loaded from the files and for alphaTex it can be specified with a range of metadata options.
81+
The available options on the stylesheet are:
82+
83+
84+
<AlphaTab tex="true" tracks="all">{`
85+
\\multiBarRest
86+
.
87+
\\track "Piano 1" "pno1"
88+
\\staff {score}
89+
C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | C4
90+
91+
\\track "Piano 2" "pno1"
92+
\\staff {score}
93+
C4 D4 E4 F4 | r | r | C4 D4 E4 F4 | r | r | r | r |
94+
`}</AlphaTab>

0 commit comments

Comments
 (0)