Skip to content

Commit 2a17e78

Browse files
committed
docs: update remaining release notes and reference docs
1 parent 869b6cc commit 2a17e78

File tree

105 files changed

+1037
-54
lines changed

Some content is hidden

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

105 files changed

+1037
-54
lines changed

docs/alphatex/_bar-metadata.mdx

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -720,3 +720,170 @@ This tag allows specifying the sustain pedal relative to the bar. The sustain pe
720720
721721
`}</AlphaTexSample>
722722

723+
## `\voiceMode`
724+
725+
```plain title="Syntax"
726+
\voiceMode mode
727+
```
728+
729+
**Description:** Changes the mode how alphaTab should treat voices when adding `\voice`.
730+
731+
You can either choose to write voice-by-voice where each voice has all bars defined.
732+
You write bar-by-bar where a new voice is only added to the current bar.
733+
734+
735+
**Parameters:**
736+
737+
| Name | Description | Type | Required |
738+
|------|-------------|------|----------|
739+
| `mode` | The mode which should be active | `staffWise\|barWise` | yes |
740+
741+
**Parameter Values:**
742+
743+
Following parameters have value limitations
744+
745+
| Name | Values |
746+
|------|--------|
747+
| `mode` | <ParameterValuesTable values={[["staffWise","Staff-Wise voices"],["barWise","Bar-Wise voices"]]} /> |
748+
749+
**Example:**
750+
751+
<AlphaTexSample tracks="all" player={true} >{`
752+
\\title "Staff Wise Voices"
753+
\\voiceMode staffWise
754+
// Voice 1
755+
\\voice
756+
// Bar 1 Voice 1
757+
C4*4 |
758+
// Bar 2 Voice 1
759+
C5*4 |
760+
// Bar 3 Voice 1
761+
C6*4
762+
// Voice 2
763+
\\voice
764+
// Bar 1 Voice 2
765+
C3*4 |
766+
// Bar 2 Voice 2
767+
C4*4 |
768+
// Bar 3 Voice 2
769+
C5 * 4
770+
771+
`}</AlphaTexSample>
772+
<AlphaTexSample tracks="all" player={true} >{`
773+
\\title "Bar Wise Voices"
774+
\\voiceMode barWise
775+
// Bar 1
776+
// Bar 1 Voice 1
777+
\\voice
778+
C4*4
779+
// Bar 1 Voice 2
780+
\\voice
781+
C3*4
782+
|
783+
// Bar 2
784+
// Bar 2 Voice 1
785+
\\voice
786+
C5*4
787+
// Bar 2 Voice 2
788+
\\voice
789+
C4*4
790+
|
791+
// Bar 3
792+
// Bar 3 Voice 1
793+
\\voice
794+
C6*4
795+
// Bar 3 Voice 2
796+
\\voice
797+
C5 * 4
798+
799+
`}</AlphaTexSample>
800+
801+
## `\barNumberDisplay`
802+
803+
```plain title="Syntax"
804+
\barNumberDisplay mode
805+
```
806+
807+
**Description:** Sets the display mode for bar numbers.
808+
809+
**Parameters:**
810+
811+
| Name | Description | Type | Required |
812+
|------|-------------|------|----------|
813+
| `mode` | The mode to use | `allBars\|firstOfSystem\|hide` | yes |
814+
815+
**Parameter Values:**
816+
817+
Following parameters have value limitations
818+
819+
| Name | Values |
820+
|------|--------|
821+
| `mode` | <ParameterValuesTable values={[["allBars","All bars"],["firstOfSystem","First bar of every system"],["hide","Hide"]]} /> |
822+
823+
**Example:**
824+
825+
<AlphaTexSample tracks="all" player={true} settings={{"display":{"layoutMode":"Parchment"}}}>{`
826+
\\defaultBarNumberDisplay hide
827+
\\track { defaultsystemslayout 3 }
828+
C4.1 | \\barNumberDisplay allBars C4.1 | C4.1 |
829+
\\barNumberDisplay firstOfSystem C4.1 | \\barNumberDisplay firstOfSystem C4.1 | C4.1
830+
831+
`}</AlphaTexSample>
832+
<AlphaTexSample tracks="all" player={true} settings={{"display":{"layoutMode":"Parchment"}}}>{`
833+
\\defaultBarNumberDisplay firstOfSystem
834+
\\track { defaultsystemslayout 3 }
835+
C4.1 | \\barNumberDisplay allBars C4.1 | C4.1 |
836+
\\barNumberDisplay hide C4.1 | C4.1 | C4.1
837+
838+
`}</AlphaTexSample>
839+
840+
## `\beaming`
841+
842+
```plain title="Syntax"
843+
\beaming (duration groups)
844+
```
845+
846+
**Description:** Defines a custom beaming rule defining how beams of certain durations should be beamed.
847+
848+
To define how beats should be beamed we need 2 parts:
849+
850+
1. A duration with which we splitup the bars
851+
2. A list of group sizes defining how many split-parts should be beamed together.
852+
853+
The beaming rules go hand-in-hand with the time signature as the rules need to properly
854+
define the groups for the whole beat.
855+
856+
Let's take a simple example of a 4/4 time signature. If we want to ensure that the beats within the quarter notes are
857+
beamed together we can write variants like this:
858+
859+
a. `\beaming (4 1 1 1 1)`
860+
b. `\beaming (8 2 2 2 2)`
861+
c. `\beaming (16 4 4 4 4)`
862+
863+
We slice the bar into 4, 8 or 16 parts. Then we add "groups" to those parts. If two beats start in the same group, they can be beamed together.
864+
Simple as that.
865+
866+
There are some common guidelines on how beaming "should be done" and alphaTab ships a wide range of defaults. But in case of more specialized time signatures,
867+
you can also customize the beaming as you need by slicing the bar and grouping the beats as needed.
868+
869+
870+
**Parameters:**
871+
872+
| Name | Description | Type | Required |
873+
|------|-------------|------|----------|
874+
| `duration` | The note duration defining the smallest group size | `Number` | yes |
875+
| `groups` | For every group the number of notes contained in the group. | `Number[]` | no |
876+
877+
**Example:**
878+
879+
<AlphaTexSample tracks="all" player={true} >{`
880+
\\ts (4 4)
881+
\\beaming (8 4 2 2)
882+
C4.8 * 8 |
883+
884+
\\ts (4 4)
885+
\\beaming (8 4 4)
886+
C4.8 * 8
887+
888+
`}</AlphaTexSample>
889+

docs/alphatex/_beat-properties.mdx

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -889,7 +889,7 @@ C4 {balance 0} D4 E4 {balance 16} F4
889889
## `tp`
890890

891891
```plain title="Syntax"
892-
tp speed
892+
tp (marks style)
893893
```
894894

895895
**Description:** Add a tremolo picking to the beat.
@@ -898,20 +898,28 @@ tp speed
898898

899899
| Name | Description | Type | Required |
900900
|------|-------------|------|----------|
901-
| `speed` | The tremolo picking speed | `8\|16\|32` | yes |
901+
| `marks` | The number of tremolo marks | `Number` | yes |
902+
| `style` | The tremolo style | `default\|buzzRoll` | no |
902903

903904
**Parameter Values:**
904905

905906
Following parameters have value limitations
906907

907908
| Name | Values |
908909
|------|--------|
909-
| `speed` | <ParameterValuesTable values={[["8","8th Notes"],["16","16th Notes"],["32","32nd Notes"]]} /> |
910+
| `marks` | <ParameterValuesTable values={[["1","1 tremolo mark (8th notes)"],["2","2 tremolo mark (16th notes)"],["3","3 tremolo mark (32nd notes)"],["4","4 tremolo mark (64th notes)"],["5","5 tremolo mark (128th notes)"]]} /> |
911+
| `style` | <ParameterValuesTable values={[["default","Default tremolo"],["buzzRoll","Buzz roll tremolo"]]} /> |
910912

911913
**Example:**
912914

913915
<AlphaTexSample tracks="all" player={true} >{`
914-
3.3{tp 8} 3.3{tp 16} 3.3{tp 32}
916+
3.3{tp 1} 3.3{tp 2} 3.3{tp 3}
917+
918+
`}</AlphaTexSample>
919+
<AlphaTexSample tracks="all" player={true} >{`
920+
\\title "Buzz Rolls"
921+
3.3{tp (0 buzzRoll)} // no audio
922+
3.3{tp (1 buzzRoll)} // 8th notes tremolo shown as buzzroll
915923
916924
`}</AlphaTexSample>
917925

0 commit comments

Comments
 (0)